diff --git a/.env.example b/.env.example index bd1130f..362c4b3 100644 --- a/.env.example +++ b/.env.example @@ -5,3 +5,8 @@ API_PWD='dummy&P@ssw0rd!' SENTRY_DSN= DEBUG= LOGIN= + +S3_ENDPOINT_URL=your_s3_url +S3_ACCESS_KEY=your_s3_access_key +S3_SECRET_KEY=your_s3_secret_key +S3_REGION=your_s3_region diff --git a/README.md b/README.md index e6699ab..5af38ad 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,10 @@ This file will have to hold the following information: - `API_URL`: URL to the endpoint of [Pyronear Alert API](https://github.com/pyronear/pyro-api) - `API_LOGIN`: your login for the API - `API_PWD`: your password for the API +- `S3_ENDPOINT_URL`: your s3 url (S3 settings to manage occlusion masks) +- `S3_ACCESS_KEY` : your s3 access key id +- `S3_SECRET_KEY`: your s3 secret key +- `S3_REGION`: s3 region Optionally, the following information can be added: - `SENTRY_DSN`: the URL of the [Sentry](https://sentry.io/) project, which monitors back-end errors and report them back.