Browse Source

Added note on required environment variables.

add-file-preservation
Drew Short 5 years ago
parent
commit
19c07e91d1
  1. 5
      README.md

5
README.md

@ -36,6 +36,11 @@ The S3 compatible endpoint needs to be configured in the `s3` object of the conf
- `secure` - specifies if __*https*__ protocol is used. - `secure` - specifies if __*https*__ protocol is used.
- `host` - is the \<hostname>\[:\<port>] for the S3 compatible endpoint. - `host` - is the \<hostname>\[:\<port>] for the S3 compatible endpoint.
Additionally the following environment variables need to be populated to interact with the S3 endpoint.
- `ACM_S3_ACCESS` - A valid S3 Access Key for the endpoint.
- `ACM_S3_SECRET` - A valid S3 Secret Key for the Access Key on the endpoint.
### Common Options ### Common Options
- `-c, --config`: The config file to read. Default file is `acm-config.json` in the current directory. - `-c, --config`: The config file to read. Default file is `acm-config.json` in the current directory.

Loading…
Cancel
Save