public-mirrors
/
composer
mirror of https://github.com/composer/composer
1
0
Fork 0
Code

Merge pull request #4642 from JamesRezo/doc/satis 

Satis documentation updates
pull/4670/head
Rob 2015-12-03 11:41:41 +01:00
parent 9959d33dd0 ff93bd5bf2
commit 824879a8d5
1 changed files with 34 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
doc/articles/handling-private-packages-with-satis.md
View File

@ -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 `output-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
@ -253,3 +279,10 @@ When searching for packages, satis will attempt to resolve all the required pack
Therefore, if you are requiring a package from Packagist, you will need to define it in your `satis.json`.
Dev dependencies are packaged only if the `require-dev-dependencies` parameter is set to true.
### Other options
* `output-dir`: optional, defines where to output the repository files
if not provided as an argument when calling the `build` command.
* `config`: optional, lets you define all config options from composer, except `archive-format` and `archive-dir` as the configuration is done through [archive](#downloads) instead. See
(http://getcomposer.org/doc/04-schema.md#config)