Skip to content

Add S3 info readme and example .env #264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Add S3 info readme and example .env #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
59698aa
docs: Added code of conduct
fe51 Feb 20, 2025
eb42147
Merge branch 'main' of github.com:pyronear/pyro-platform
fe51 Feb 20, 2025
69dfad3
Merge branch 'main' of github.com:pyronear/pyro-platform
fe51 Feb 20, 2025
8a0e67b
Merge branch 'main' of github.com:pyronear/pyro-platform
fe51 Mar 20, 2025
8ac3ff0
Merge branch 'main' of github.com:pyronear/pyro-platform
fe51 Aug 10, 2025
d153cb7
Merge branch 'main' of github.com:pyronear/pyro-platform
fe51 Sep 12, 2025
d1e595f
Added missing ex variables info
fe51 Sep 12, 2025
10e6a2c
typo
fe51 Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading