-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Previously mojdigital/satis-s3 was based on iainmackay/satis-s3. Now they have been consolidated into one image. This was to allow the arguments to run.sh to be modified, as previously they were hardcoded in iainmackay/satis-s3. These arguments can now be specified as environment variables. This step was taken, due to the changes to the CircleCi YML format. The previous was volumes were mounted could not be replicated with the 2.0 format.
- Loading branch information
Showing
3 changed files
with
51 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,31 @@ | ||
# satis-s3 | ||
|
||
A docker image to build a composer repository using [satis](https://github.com/composer/satis), and upload it to an AWS S3 bucket. | ||
A docker image to build a composer repository using [satis](https://github.com/composer/satis), | ||
and upload it to an AWS S3 bucket. | ||
|
||
This image extends [iainmckay/satis-s3](https://github.com/iainmckay/satis-s3). | ||
This is based on (but no longer extends) [iainmckay/satis-s3](https://github.com/iainmckay/satis-s3). | ||
|
||
## Configuration | ||
|
||
The script requires the following environment variables: | ||
The script recognizes the following environment variables. | ||
For development and testing purposes, copy .env.example to .env and specify the correct environment variables | ||
|
||
Name | Description | Required | ||
---- | ----------- | -------- | ||
`AWS_ACCESS_KEY_ID` | Your AWS access key | Required | ||
`AWS_SECRET_ACCESS_KEY` | Your AWS secret access key | Required | ||
`AWS_DEFAULT_REGION` | The AWS region the bucket is in | Required | ||
`GITHUB_AUTH` | [Personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) for access to GitHub. Use this to avoid hitting GitHub API rate limits. | Optional | ||
`S3_BUCKET` | The bucket to write the artifacts to | Required | ||
`S3_PATH` | The path inside the bucket to write the artifacts to | Optional | ||
#### Required environment variables | ||
|
||
- `AWS_ACCESS_KEY_ID` Your AWS access key | ||
|
||
- `AWS_SECRET_ACCESS_KEY` Your AWS secret access key | ||
|
||
- `AWS_DEFAULT_REGION` The AWS region the bucket is in | ||
|
||
- `CONFIG_PATH` The path to the Satis config.json file | ||
|
||
- `OUT_PATH` The path of where the Satis repo should be built | ||
|
||
- `S3_BUCKET` The bucket to write the artifacts to | ||
|
||
#### Optional environment variables | ||
|
||
- `GITHUB_AUTH` [Personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) for access to GitHub. Use this to avoid hitting GitHub API rate limits. | ||
|
||
- `S3_PATH` The path inside the bucket to write the artifacts to |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters