|
| 1 | +# Satis |
| 2 | + |
| 3 | +Simple static Composer repository generator. |
| 4 | + |
| 5 | +[](https://travis-ci.org/composer/satis) |
| 6 | + |
| 7 | + |
| 8 | +## Run from source |
| 9 | + |
| 10 | +- Install satis: `composer create-project composer/satis:dev-master --keep-vcs` |
| 11 | +- Build a repository: `php bin/satis build <configuration-file> <output-dir>` |
| 12 | + |
| 13 | +Read the more detailed instructions in the [documentation][]. |
| 14 | + |
| 15 | + |
| 16 | +## Run as Docker container |
| 17 | + |
| 18 | +Pull the image: |
| 19 | + |
| 20 | +``` sh |
| 21 | +docker pull composer/satis |
| 22 | +``` |
| 23 | + |
| 24 | +Run the image: |
| 25 | + |
| 26 | +``` sh |
| 27 | +docker run --rm -it -v /build:/build composer/satis |
| 28 | +``` |
| 29 | + |
| 30 | + > Note: by default it will look for a configuration file named `satis.json` |
| 31 | + inside the `/build` directory and dump the generated output files in |
| 32 | + `/build/output`. |
| 33 | + |
| 34 | +Run the image (with Composer cache from host): |
| 35 | + |
| 36 | +``` sh |
| 37 | +docker run --rm -it -v /build:/build -v $COMPOSER_HOME:/composer composer/satis |
| 38 | +``` |
| 39 | + |
| 40 | +If you want to run the image without implicitly running Satis, you have to |
| 41 | +override the entrypoint specified in the `Dockerfile`: |
| 42 | + |
| 43 | +``` sh |
| 44 | +docker run --rm -it --entrypoint /bin/sh composer/satis |
| 45 | +``` |
| 46 | + |
| 47 | + |
| 48 | +## Purge |
| 49 | + |
| 50 | +If you choose to archive packages as part of your build, over time you can be |
| 51 | +left with useless files. With the `purge` command, you can delete these files. |
| 52 | + |
| 53 | +``` sh |
| 54 | +php bin/satis purge <configuration-file> <output-dir> |
| 55 | +``` |
| 56 | + |
| 57 | + > Note: don't do this unless you are certain your projects no longer reference |
| 58 | + any of these archives in their `composer.lock` files. |
| 59 | + |
| 60 | + |
| 61 | +## Updating |
| 62 | + |
| 63 | +Updating Satis is as simple as running `git pull && composer update` in the |
| 64 | +Satis directory. |
| 65 | + |
| 66 | +If you are running Satis as a Docker container, simply pull the latest image. |
| 67 | + |
| 68 | + |
| 69 | +## Contributing |
| 70 | + |
| 71 | +Please note that this project is released with a [Contributor Code of Conduct][]. |
| 72 | +By participating in this project you agree to abide by its terms. |
| 73 | + |
| 74 | +Fork the project, create a feature branch, and send us a pull request. |
| 75 | + |
| 76 | + |
| 77 | +## Authors |
| 78 | + |
| 79 | +See the list of [contributors][] who participate(d) in this project. |
| 80 | + |
| 81 | + |
| 82 | +## Community Tools |
| 83 | + |
| 84 | +- [satis-go][] - A simple web server for managing Satis configuration and |
| 85 | + hosting the generated Composer repository. |
| 86 | +- [satisfy][] - Symfony based composer repository manager with a simple web UI. |
| 87 | +- [satis-control-panel][] - Simple web UI for managing your Satis Repository |
| 88 | + with optional CI integration. |
| 89 | +- [composer-satis-builder][] - Simple tool for updating the Satis configuration |
| 90 | + (satis.json) "require" key on the basis of the project composer.json. |
| 91 | + |
| 92 | + |
| 93 | +## License |
| 94 | + |
| 95 | +Satis is licensed under the MIT License - see the [LICENSE][] file for details |
| 96 | + |
| 97 | + |
| 98 | +[documentation]: https://getcomposer.org/doc/articles/handling-private-packages-with-satis.md |
| 99 | +[Contributor Code of Conduct]: http://contributor-covenant.org/version/1/4/ |
| 100 | +[contributors]: https://github.com/composer/satis/contributors |
| 101 | +[satis-go]: https://github.com/benschw/satis-go |
| 102 | +[satisfy]: https://github.com/ludofleury/satisfy |
| 103 | +[satis-control-panel]: https://github.com/realshadow/satis-control-panel |
| 104 | +[composer-satis-builder]: https://github.com/AOEpeople/composer-satis-builder |
| 105 | +[LICENSE]: https://github.com/composer/satis/blob/master/LICENSE |
0 commit comments