Skip to content

Commit 7db5b27

Browse files
authored
Add S3 info readme and example .env (#264)
* docs: Added code of conduct * Added missing ex variables info * typo
1 parent b8abe70 commit 7db5b27

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

.env.example

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,8 @@ API_PWD='dummy&P@ssw0rd!'
55
SENTRY_DSN=
66
DEBUG=
77
LOGIN=
8+
9+
S3_ENDPOINT_URL=your_s3_url
10+
S3_ACCESS_KEY=your_s3_access_key
11+
S3_SECRET_KEY=your_s3_secret_key
12+
S3_REGION=your_s3_region

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ This file will have to hold the following information:
2323
- `API_URL`: URL to the endpoint of [Pyronear Alert API](https://github.com/pyronear/pyro-api)
2424
- `API_LOGIN`: your login for the API
2525
- `API_PWD`: your password for the API
26+
- `S3_ENDPOINT_URL`: your s3 url (S3 settings to manage occlusion masks)
27+
- `S3_ACCESS_KEY` : your s3 access key id
28+
- `S3_SECRET_KEY`: your s3 secret key
29+
- `S3_REGION`: s3 region
2630

2731
Optionally, the following information can be added:
2832
- `SENTRY_DSN`: the URL of the [Sentry](https://sentry.io/) project, which monitors back-end errors and report them back.

0 commit comments

Comments
 (0)