Simple static Composer repository generator
PHP HTML
Latest commit 2ce60ae Jul 18, 2016 @alcohol alcohol committed on GitHub Merge pull request #345 from kevindierkx/master
Changed package anchor, resolves #343

README.md

Satis - Package Repository Generator

Simple static Composer repository generator.

It uses any composer.json file as input and dumps all the required (according to their version constraints) packages into a Composer Repository file.

Build Status

Usage

  • Download Composer: curl -sS https://getcomposer.org/composer.phar -o composer.phar
  • Install satis: php composer.phar create-project composer/satis --stability=dev --keep-vcs
  • Build a repository: php bin/satis build <configuration file> <build-dir>

Read the more detailed instructions in the documentation.

Purge

If you choose to archive packages in your server, you can have useless files.
With the purge command, you delete these files.

php bin/satis purge <composer.json> <build-dir>

Note: be careful if you reference your archives in your lock file.

Updating

Updating is as simple as running git pull && php composer.phar install in the satis directory.

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.

Requirements

PHP 5.5+

Authors

Jordi Boggiano - j.boggiano@seld.be - http://twitter.com/seldaek - http://seld.be
Nils Adermann - naderman@naderman.de - http://twitter.com/naderman - http://www.naderman.de

See also the list of contributors who participated in this project.

Community Tools

  • satis-go - A simple web server for managing Satis configuration and hosting the generated Composer repository.
  • satisfy - Symfony based composer repository manager with a simple web UI.
  • satis-control-panel - Simple web UI for managing your Satis Repository with optional CI integration.
  • composer-satis-builder - Simple tool for updating the Satis configuration (satis.json) "require" key on the basis of the project composer.json.

License

Satis is licensed under the MIT License - see the LICENSE file for details