Simple static Composer repository generator - For a full private Composer repo use Private Packagist
MIT License
2866
102
491

Satis

Simple static Composer repository generator.

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 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

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.

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

License

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

Contributors

alcohol
Seldaek
JamesRezo
naderman
theimbender
glensc
staabm
till
GromNaN
simesy
carusogabriel
shochdoerfer
CarsonF
copitz
pavog
ph-fritsche
Flyingmana
hsegnitz
andrerom
kevindierkx
kornrunner
cs278
stof
DavidGarciaCat
jakzal
h4cc
miklos-martin
omansour
sokolnikov911
freezy-sk
andygrunwald
epoplive
rawkode
thedava
Deamon
GwendolenLynch
gennadiylitvinyuk
lyrixx
joshdifabio
klj613
Gounlaf
mpaepper
MatthiasKuehneEllerhold
zerustech
mvorisek
skolodyazhnyy
SunMar
SvenRtbg
auipga
caouecs
JeroenDeDauw
Divi
pulkitjalan
Adirelle
andreybolonin
AnrDaemon
antoniocambados
ArtursL
benschw
akimsko
bradjones1
felixbuenemann
Slamdunk
cfv1000
glynnforrest
Grummfy
hpuac
JTubex
igorw
rtm-ctrlz
Ilyes512
Inscure
kamioftea
gammamatrix
Jeroeny
jyggen
MoT3rror
giggsey
c33s
jdeniau
julienj
qzminski
kmadejski
ksangers
konradoboza
kriswallsmith
fooman
lancechentw
cordoval
realshadow
mathroc
mpdude
mbabker
mlocati
moebrowne
nikolareljin
luckyraul
Steveb-p
kpitn
prudloff-insite