composer / satis
Simple Repository Generator
Fund package maintenance!
packagist.com
Installs: 1 185 343
Dependents: 19
Suggesters: 0
Security: 0
Stars: 3 147
Watchers: 95
Forks: 520
Open Issues: 100
Type:composer-plugin
Requires
- php: ^5.6 || ^7.0
- composer/composer: ^1.4
- symfony/console: ^2.1 || ^3.0.4
- twig/twig: ^1.7 || ^2.0
Requires (Dev)
- mikey179/vfsstream: ^1.6
- phpunit/phpunit: ^4.5 || ^5.0.5
- phpunit/phpunit-mock-objects: 2.3.0 || ^3.0
This package is auto-updated.
Last update: 2024-12-16 09:42:00 UTC
README
A simple static Composer repository generator.
About
Satis is a tool that allows PHP developers to create a private package repository for their projects' dependencies. It provides increased control over package distribution, improved security, and faster package installations, by creating a static Composer registry that can be hosted anywhere (even via Docker, locally).
Run from source
Satis requires a recent PHP version, it does not run with unsupported PHP versions. Check the composer.json
file for details.
- Install Satis:
composer create-project --keep-vcs --no-dev composer/satis:dev-main
- Build a repository:
php bin/satis build <configuration-file> <output-directory>
Read the more detailed instructions in the documentation.
Run as Docker container
Note: use
composer/satis
for Docker Hub,ghcr.io/composer/satis
for GitHub container registry.
Pull the image:
docker pull composer/satis
Run the image (with Composer cache from host):
docker run --rm --init -it \ --user $(id -u):$(id -g) \ --volume $(pwd):/build \ --volume "${COMPOSER_HOME:-$HOME/.composer}:/composer" \ composer/satis build <configuration-file> <output-directory>
If you want to run the image without implicitly running Satis, you have to
override the entrypoint specified in the Dockerfile
:
--entrypoint /bin/sh
Purge
If you choose to archive packages as part of your build, over time you can be
left with useless files. With the purge
command, you can delete these files.
php bin/satis purge <configuration-file> <output-dir>
Note: don't do this unless you are certain your projects no longer reference any of these archives in their
composer.lock
files.
Updating
Updating Satis is as simple as running git pull && composer install
in the
Satis directory.
If you are running Satis as a Docker container, simply pull the latest image.
Contributing
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Fork the project, create a feature branch, and send us a pull request.
If you introduce a new feature, or fix a bug, please try to include a testcase.
While not required, it is appreciated if your contribution meets our coding standards.
You can check these yourself by running the tools we use:
# install tooling & dependencies for d in tools/*; do composer --working-dir=$d install; done # run php-cs-fixer tools/php-cs-fixer/vendor/bin/php-cs-fixer fix # run phpstan tools/phpstan/vendor/bin/phpstan # alternatively, use the shortcuts composer phpstan composer php-cs-fixer[-fix]
Authors
See the list of contributors who participate(d) in this project.
Community Tools
- satisfy - Symfony based composer repository manager with a simple web UI.
Examples
- eventum/composer - A simple static set of packages hosted in GitHub Pages
- satis.spatie.be - A brief guide to setting up and securing a Satis repository
License
Satis is licensed under the MIT License - see the LICENSE file for details