From 33f725e99b8b678fc426eb425d9114eab46f4253 Mon Sep 17 00:00:00 2001 From: JamesRezo Date: Thu, 26 Nov 2015 16:31:49 +0100 Subject: [PATCH] Satis documentation updates --- .../handling-private-packages-with-satis.md | 28 ++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/doc/articles/handling-private-packages-with-satis.md b/doc/articles/handling-private-packages-with-satis.md index 4294de4fb..4b58a4137 100644 --- a/doc/articles/handling-private-packages-with-satis.md +++ b/doc/articles/handling-private-packages-with-satis.md @@ -220,10 +220,14 @@ following to your `satis.json`: #### Options explained - * `directory`: the location of the dist files (inside the `output-dir`) + * `directory`: required, the location of the dist files (inside the `output-dir`) * `format`: optional, `zip` (default) or `tar` * `prefix-url`: optional, location of the downloads, homepage (from `satis.json`) followed by `directory` by default * `skip-dev`: optional, `false` by default, when enabled (`true`) satis will not create downloads for branches +* `absolute-directory`: optional, a _local_ directory where the dist files are dumped instead of `outpur-dir`/`directory` +* `whitelist`: optional, if set as a list of package names, satis will only dump the dist files of these packages +* `blacklist`: optional, if set as a list of package names, satis will not dump the dist files of these packages +* `checksum`: optional, `true` by default, when disabled (`false`) satis will not provide the sha1 checksum for the dist files Once enabled, all downloads (include those from GitHub and BitBucket) will be replaced with a _local_ version. @@ -235,6 +239,28 @@ bucket or on a CDN host. A CDN would drastically improve download times and ther Example: A `prefix-url` of `https://my-bucket.s3.amazonaws.com` (and `directory` set to `dist`) creates download URLs which look like the following: `https://my-bucket.s3.amazonaws.com/dist/vendor-package-version-ref.zip`. +### Web outputs + +* `output-html`: optional, `true` by default, when disabled (`false`) satis will not generate the `output-dir`/index.html page. +* `twig-template`: optional, a path to a personalized [Twig](http://twig.sensiolabs.org/) template for the `output-dir`/index.html page. + +### Abandoned packages + +To enable your satis installation to indicate that some packages are abandoned, add the following to your `satis.json`: + +```json +{ + "abandoned": { + "company/package": true, + "company/package2": "company/newpackage" + } +} +``` + +The `true` value indicates that the package is truly abandoned while the `"company/newpackage"` value specifies that the package is replaced by +the `company/newpackage` package. + +Note that all packages set as abandoned in their own `composer.json` file will be marked abandoned as well. ### Resolving dependencies