playbloom / satisfy
Satis composer repository manager with a Web UI
Installs: 10 537
Dependents: 0
Suggesters: 0
Security: 0
Stars: 518
Watchers: 16
Forks: 110
Open Issues: 5
Type:project
Requires
- php: ^8.1,<8.3
- ext-json: *
- ext-xml: *
- composer/composer: ^2.4
- composer/satis: dev-main
- doctrine/annotations: ~1.6
- doctrine/instantiator: ~1.1
- incenteev/composer-parameter-handler: ^2.1
- laminas/laminas-diactoros: ^2.3
- ninsuo/symfony-collection: ^2.1
- ramunasd/symfony-container-mocks: ^0.6.0
- swop/github-webhook: ^3.1
- symfony/asset: ^5.4
- symfony/dependency-injection: ^5.4
- symfony/dotenv: ^6.4
- symfony/event-dispatcher: ^5.4
- symfony/form: ^5.4
- symfony/framework-bundle: ^5.4
- symfony/lock: ^5.4
- symfony/monolog-bundle: ^3.8
- symfony/property-info: ^5.0
- symfony/proxy-manager-bridge: ^6.0
- symfony/psr-http-message-bridge: ^2.0
- symfony/security-bundle: ^5.4
- symfony/serializer: ^5.4
- symfony/twig-bundle: ^5.4
- symfony/validator: ^5.4
- symfony/yaml: ^5.4
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.1
- mikey179/vfsstream: ^1.6
- phpspec/prophecy-phpunit: ^2.0
- phpstan/phpstan: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpstan/phpstan-symfony: ^1.0
- phpunit/phpunit: ^10.5
- symfony/browser-kit: ^5.4
This package is auto-updated.
Last update: 2024-10-24 15:01:38 UTC
README
Satis Composer repository manager with a simple web UI.
Introduction
Satisfy provides:
- a Web UI: A CRUD to manage your satis configuration file
- a simple security layer with a login form
- a webhook endpoints for the most popular version control systems
- Satis itself
Satisfy ease your satis configuration management. It provides a simple web UI over Satis to avoid a hand-editing of the satis.json configuration file. All repositories from a composer.lock file can also be imported via upload.
How it works?
Basically, it just reads/writes the satis.json file and provides a web CRUD.
- On each HTTP request, the satis.json is loaded.
- If a write occurs in this file, a backup is made in var/satis/
Installation
Composer
- Clone project
git clone https://github.com/project-satisfy/satisfy.git
- Download composer
wget http://getcomposer.org/composer.phar
- Install
php composer.phar install -n
Satis configuration
- Either define your default/existing satis configuration
- or use interactice satis CLI tool
./bin/satis init
- or submit form at /admin/configuration
By default, the satis.json
file is expected at the project root, but You can set another path under the parameter satis_filename
.
Application configuration
- Customize
app/config/parameters.yml
according to your needs.
Security
You can restrict the access setting admin.auth
parameter (in app/config/parameters.yml
) to true
. Set authorized users in admin.users
config array.
Run Satisfy
Create a web server pointing to the public
directory. Browse to »/admin/« to manage the satis.json
. To serve the package.json
it is required to run Satis first.
Satis packages definition generation
Since Satisfy does only manages the Satis configuration file, it is necessary to build the package definitions using Satis.
A bin shortcut to Satis is already included in Satisfy, so run the following command to generate the files in the web folder.
./bin/satis build
Automatically build a single package using WebHooks
For example, you can trigger a package generation for your BitBucket project by setting up a BitBucket webhook to connect back to [your-satis-url]/webhook/bitbucket every time you do a code push. This is more efficient than doing a full build and avoids you having to run full builds on a frequent schedule or logging in to the admin interface just to force a build.
Prebuilt docker image
You can run satisfy using prebuilt docker image. Here is an example how to setup it.
- Create dir for configuration files
- Add parameters.yml file, can be copied from config/parameters.yml.dist
- Add auth.json with all required composer authentication tokens
- Add simple satis.json with basic information
- Create docker-compose.yml using example below
- Start containers
docker-compose up
- Access container shell
docker-compose exec php bash
- Run initial build
./bin/satis build
- Open satis page on
http://localhost:8000
version: '3'
services:
php:
image: ghcr.io/project-satisfy/satisfy:latest
ports:
- "${APP_PORT:-8000}:80"
volumes:
- ./satis.json:/var/www/html/satis.json
- ./parameters.yml:/var/www/html/config/parameters.yml
- ./auth.json:/var/www/.composer/auth.json:ro
environment:
APP_ENV: ${APP_ENV:-dev}
APP_DEBUG: ${APP_DEBUG:-1}
Authors
- Ludovic Fleury - ludo.fleury@gmail.com - http://twitter.com/ludofleury
- Julius Beckmann - satisfy@h4cc.de - https://twitter.com/h4cc
- Ramūnas Dronga - satisfy@ramuno.lt
License
Satisfy is licensed under the MIT License - see the LICENSE file for details