Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Rarst/release-belt
Composer repository implementation for ZIPs.
https://github.com/Rarst/release-belt
composer repository
Last synced: 2 months ago
JSON representation
Composer repository implementation for ZIPs.
- Host: GitHub
- URL: https://github.com/Rarst/release-belt
- Owner: Rarst
- License: mit
- Created: 2014-11-26T22:58:27.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2022-07-20T13:49:13.000Z (over 2 years ago)
- Last Synced: 2024-10-27T22:09:08.283Z (3 months ago)
- Topics: composer, repository
- Language: PHP
- Homepage:
- Size: 265 KB
- Stars: 170
- Watchers: 13
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-composer - Release Belt - Self–hosted Composer repository implementation to quickly integrate ZIP files of third party non–Composer releases. (Packagist-compatible repositories / Repman)
README
# Release Belt — Composer repo for ZIPs
[](https://github.com/Rarst/release-belt/actions/workflows/tests.yml)
[](https://packagist.org/packages/rarst/release-belt)
[](https://packagist.org/packages/rarst/release-belt)
[](https://github.com/php-pds/skeleton)
Release Belt is a Composer repository, which serves to quickly integrate third–party non–Composer releases into Composer workflow. Once Release Belt is installed and you upload your zip files with their respective version number, Release Belt does the rest.
Given the following folder tree:
```
releases/wordpress-plugin/rarst/plugin.1.0.zip
```
It will serve the following Composer repository at `/packages.json` automagically:
```json
{
"packages": {
"rarst/plugin": {
"1.0": {
"name": "rarst/plugin",
"version": "1.0",
"dist": {
"url": "http://example.com/rarst/plugin.1.0.zip",
"type": "zip"
},
"type": "wordpress-plugin",
"require": {
"composer/installers": "^1.5"
}
}
}
}
}
```
## Installation
### 1. Install the project
Release Belt is a `project` type Composer package. It is recommended to use Git checkout to keep up with updates more easily.
There is a helper Composer script provided that tries to fetch latest stable version and performs Composer install.
#### Install
```bash
git clone https://github.com/Rarst/release-belt
cd release-belt
composer belt-update
```
#### Update
```bash
composer belt-update
```
### 2. Place release ZIPs into `releases/` directory
The directory structure should be: `releases/[type]/[vendor name]/[release zip file]`.
A `[type]` could be:
- a [native Composer type](https://getcomposer.org/doc/04-schema.md#type) (e.g. `library` for the default);
- any type [`composer/installers` supports](https://github.com/composer/installers) (e.g. `wordpress-plugin`);
- or completely arbitrary.
### 3. Configure a web server
The `public/` directory should be used as web root and `index.php` in it as the file to handle requests.
Please refer to [web server configuration](https://www.slimframework.com/docs/v4/start/web-servers.html) in Slim documentation and/or your web hosting’s resources for setup specifics.
Visit home page and `/packages.json` in a web browser to check if it is working.
## Use
Once Release Belt is installed you can add the repository to the `composer.json` of your projects.
Release Belt home page will automatically generate some `composer.json` boilerplate for you to use.
### Configuration
You can configure Release Belt by creating a `config/config.php` file, which returns an array of options to override.
See [`config/configExample.php`](config/configExample.php) for the annotated example.
#### Authentication & permissions
Release Belt implements HTTP authentication to password protect your repository and control access to specific packages. You can configure it via `users` configuration option.
There is a `bin/encodePassword.php` command line helper included for hashing passwords:
```bash
>php bin/encodePassword.php foo
$2y$10$3i9/lVd8UOFIJ6PAMFt8gu3/r5g0qeCJvoSlLCsvMTythye19F77a
```
If authentication is enabled, Release Belt home page will automatically generate `auth.json` boilerplate for you to use.
## F.A.Q.
### Why not Packagist/Satis?
Composer infrastructure is awesome, but it expects vendors that are willing to play nice with it.
Release Belt is a solution for unwilling vendors and it was faster and easier to build a dedicated solution from scratch.
### Why not artifacts?
Composer artifacts require `composer.json` in them. This is for releases that don't even have that.
### But is it web scale?
No.
# License
MIT