From 378615d64658367635df991678d7e44c7b111b8b Mon Sep 17 00:00:00 2001 From: till Date: Sat, 30 Mar 2013 21:21:14 +0100 Subject: [PATCH 1/2] Documentation for satis-based downloads. --- .../handling-private-packages-with-satis.md | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/doc/articles/handling-private-packages-with-satis.md b/doc/articles/handling-private-packages-with-satis.md index 4b416cfac..9b8cebe92 100644 --- a/doc/articles/handling-private-packages-with-satis.md +++ b/doc/articles/handling-private-packages-with-satis.md @@ -128,3 +128,42 @@ Example using HTTP over SSL using a client certificate: } ] } + +### Downloads + +When Github or Bitbucket repositories are mirrored on your local satis, the build process will include +the location of the downloads these platforms make available. This means that the repository and your setup depend +on the availability of these services. + +At the same time, this implies that all code which is hosted somewhere else (on another service or for example in +Subversion) will not have downloads available and thus installations usually take a lot longer. + +To enable your satis installation to create downloads for all (Git, Mercurial and Subversion) your packages, add the +following to your `satis.json`: + + { + "archive": { + "directory": "dist", + "format": "tar", + "prefix-url": "https://amazing.cdn.example.org", + "skip-dev": true + } + } + +#### Options explained + + * `directory`: the location of the dist files (inside the `output-dir`) + * `format`: `zip` (default) or `tar` + * `prefix-url`: homepage (from `satis.json`) by default (followed by `directory`) + * `skip-dev`: when enabled (`true`) we will not create downloads for branches, `false` by default + +Once enabled, all downloads (even those from Github and Bitbucket) will be replaced with a _local_ version. + +#### prefix-url + +Prefixing the URL with another host is especially helpful if the downloads end up in a private Amazon S3 +bucket or on a CDN host (which would drastically improve download times and therefor package installation). + +Example: A `prefix-url` of `http://my-bucket.s3.amazonaws.com` (and `directory` set to `dist`) creates download URLs +which look like the following: `http://my-bucket.s3.amazonaws.com/dist/vendor-package-version-ref.zip`. + From 5774f5db4a8690a7a8d52c8f9dbc97728cd7583a Mon Sep 17 00:00:00 2001 From: till Date: Sat, 30 Mar 2013 21:48:18 +0100 Subject: [PATCH 2/2] Engrish is hard. --- .../handling-private-packages-with-satis.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/doc/articles/handling-private-packages-with-satis.md b/doc/articles/handling-private-packages-with-satis.md index 9b8cebe92..adbdc8f62 100644 --- a/doc/articles/handling-private-packages-with-satis.md +++ b/doc/articles/handling-private-packages-with-satis.md @@ -131,7 +131,7 @@ Example using HTTP over SSL using a client certificate: ### Downloads -When Github or Bitbucket repositories are mirrored on your local satis, the build process will include +When GitHub or BitBucket repositories are mirrored on your local satis, the build process will include the location of the downloads these platforms make available. This means that the repository and your setup depend on the availability of these services. @@ -153,17 +153,16 @@ following to your `satis.json`: #### Options explained * `directory`: the location of the dist files (inside the `output-dir`) - * `format`: `zip` (default) or `tar` - * `prefix-url`: homepage (from `satis.json`) by default (followed by `directory`) - * `skip-dev`: when enabled (`true`) we will not create downloads for branches, `false` by default + * `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 -Once enabled, all downloads (even those from Github and Bitbucket) will be replaced with a _local_ version. +Once enabled, all downloads (include those from GitHub and BitBucket) will be replaced with a _local_ version. #### prefix-url Prefixing the URL with another host is especially helpful if the downloads end up in a private Amazon S3 -bucket or on a CDN host (which would drastically improve download times and therefor package installation). +bucket or on a CDN host. A CDN would drastically improve download times and therefore package installation. Example: A `prefix-url` of `http://my-bucket.s3.amazonaws.com` (and `directory` set to `dist`) creates download URLs which look like the following: `http://my-bucket.s3.amazonaws.com/dist/vendor-package-version-ref.zip`. -