From 91c431c90729c49d8a12d1627a71cbfd607dad4d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20P=C3=A1nek?= Date: Wed, 13 Mar 2013 10:59:02 +0100 Subject: [PATCH] Adding some more description what Satis is/does --- doc/articles/handling-private-packages-with-satis.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/doc/articles/handling-private-packages-with-satis.md b/doc/articles/handling-private-packages-with-satis.md index 3436830fa..1376bcb0b 100644 --- a/doc/articles/handling-private-packages-with-satis.md +++ b/doc/articles/handling-private-packages-with-satis.md @@ -4,8 +4,10 @@ # Handling private packages with Satis -Satis can be used to host the metadata of your company's private packages, or -your own. It basically acts as a micro-packagist. You can get it from +Satis is a static `composer` repository generator. It is a bit like an ultra- +lightweight, static file-based version of packagist and can be used to host the +metadata of your company's private packages, or your own. It basically acts as +a micro-packagist. You can get it from [GitHub](http://github.com/composer/satis) or install via CLI: `composer.phar create-project composer/satis --stability=dev`. @@ -21,6 +23,8 @@ but those could be any types of [repositories](../05-repositories.md). Then it uses `"require-all": true` which selects all versions of all packages in the repositories you defined. +The default file Satis looks for is `satis.json` in the root of the repository. + { "name": "My Repository", "homepage": "http://packages.example.org", @@ -65,7 +69,7 @@ to ssh key authentication instead of prompting for a password. This is also a good trick for continuous integration servers. Set up a virtual-host that points to that `web/` directory, let's say it is -`packages.example.org`. +`packages.example.org`. Alternatively, with PHP >= 5.4.0, you can use the built-in CLI server `php -S localhost:port` inside `web/` for a temporary solution. ## Usage