Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shyim/composer-registry

Composer v2 Registry
https://github.com/shyim/composer-registry

composer github gitlab webhook

Last synced: 20 days ago
JSON representation

Composer v2 Registry

Host: GitHub
URL: https://github.com/shyim/composer-registry
Owner: shyim
License: mit
Created: 2022-07-13T12:08:45.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-06-22T06:22:17.000Z (6 months ago)
Last Synced: 2024-11-26T22:53:50.752Z (27 days ago)
Topics: composer, github, gitlab, webhook
Language: Go
Homepage:
Size: 165 KB
Stars: 10
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Composer Registry

This Composer registry fetches multiple sources and serves them as Composer packages.

## Features

- Gitlab Support
- GitHub Support
- Mirror Shopware Composer Repository
- Adding custom packages using ZIP files

## Installation

- Download the latest version from the released files
- Create a `config.json` or a `config.yml` like your preferences.

### Docker

```shell
docker run \
-p 8080:8080 \
-v $(pwd)/config.json:/config.json \
-v $(pwd)/storage:/storage \
ghcr.io/shyim/composer-registry:latest
```

`/storage` will be used to save the database and zips if mirroring is enabled

### NixOS

Import this as flake.

```nix
inputs = {
composer-registry = {
url = "github:shyim/composer-registry";
inputs.nixpkgs.follows = "nixpkgs";
};
}
```

Import the module on your system.

```nix
{ pkgs, inputs, ... }:
{
imports = [
inputs.composer-registry.nixosModules.default
];
}
```

Activate the given service:

```nix
services.composer-registry = {
enable = true;

settings = {
base_url = "https://my.composer.io";
};
};
```

## Configuration

The base config file looks like this:

```json
{
"$schema": "https://raw.githubusercontent.com/shyim/composer-registry/main/config-schema.json",
"base_url": "http://localhost:8080"
}
```

The `base_url` is the URL where the instance is available. Currently it is not possible to change this afterwards. (This will be used only for mirroring/custom packages).

### Gitlab

```javascript
{
"$schema": "https://raw.githubusercontent.com/shyim/composer-registry/main/config-schema.json",
"base_url": "http://localhost:8080",
"providers": [
{
"name": "my-gitlab-instance", // provider name.
"type": "gitlab",
"domain": "gitlab.com", // gitlab.com or your instance domain
"token": "my-gitlab-token", // access token with read_api
"webhook_secret": "my-gitlab-webhook-secret", // webhook secret Webhook address is /webhook/
"fetch_all_on_start": true, // Fetches all packages on start, Optional
"projects": [
{
"name": "my-gitlab-group/repo" // project name to consider
}
],
"cron_schedule": "*/5 * * * *" // Cron schedule for refetching anything. Optional if you don't want to have webhooks
}
]
}
```

The registry serves only the package information, the zip will be directly downloaded from your Gitlab instance. To do this you need to configure composer too.

Add following to your `composer.json`

```json
"repositories": [
{
"type": "composer",
"url": ""
}
],
"config": {
"gitlab-domains": [""]
}
```

```shell
> composer config gitlab-token. TOKEN
```

### Github

```javascript
{
"$schema": "https://raw.githubusercontent.com/shyim/composer-registry/main/config-schema.json",
"base_url": "http://localhost:8080",
"providers": [
{
"name": "my-github-instance", // provider name.
"type": "github",
"token": "my-github-token", // personal access token
"webhook_secret": "my-github-webhook-secret", // webhook secret Webhook address is /webhook/
"fetch_all_on_start": true, // Fetches all packages on start, Optional
"projects": [
{
"name": "my-github-group/repo" // project name to consider
}
],
"cron_schedule": "*/5 * * * *" // Cron schedule for refetching anything. Optional if you don't want to have webhooks
}
]
}
```

The registry serves only the package information, the zip will be directly downloaded from your GitHub instance. To do this you need to configure composer too.

Add following to your `composer.json`

```shell
> composer config github-oauth.github.com token
```

### Mirroring Shopware Composer

```javascript
{
"$schema": "https://raw.githubusercontent.com/shyim/composer-registry/main/config-schema.json",
"base_url": "http://localhost:8080",
"providers": [
{
"name": "shopware", // provider name.
"type": "shopware",
"fetch_all_on_start": true, // Fetches all packages on start, Optional
"projects": [
{
"name": "The Composer Token" // project name to consider
}
],
"cron_schedule": "*/5 * * * *" // Cron schedule for refetching anything. Optional if you don't want to have webhooks
}
]
}
```

The registry will download all packages from the Shopware Composer repository and serve them.

### Adding custom zips as package

This will enable two API endpoints to add/update or delete packages:

Create/update package:

```http request
POST http://localhost:8080/custom/package/create
Authorization: bearer
```

The request body is the ZIP file.

Delete package:

```http request
DELETE http://localhost:8080/custom/package//
Authorization: bearer
```

# Authentication

By default, is the authentication disabled. To enabled add users to your configuration.

```json
{
"$schema": "https://raw.githubusercontent.com/shyim/composer-registry/main/config-schema.json",
"base_url": "http://localhost:8080",
"users": [
{
"token": "TOKEN"
}
]
}
```

The token can be configured like so

```shell
> composer config bearer.
```

## Rules

You can add to the tokens rules, when they match then the token will be able to download that package.

Possible types are: `begins_with`, `ends_with`, `contains`, `equals`

```json
{
"$schema": "https://raw.githubusercontent.com/shyim/composer-registry/main/config-schema.json",
"base_url": "http://localhost:8080",
"users": [
{
"token": "test",
"rules": [
{
"type": "begins_with",
"value": "store.shopware.com"
}
]
}
]
}
```