Skip to content

Commit c05b7e5

Browse files
docs: document environment variables for uploading files
1 parent a663539 commit c05b7e5

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,18 @@ alembic upgrade head
3131

3232
### S3 environment variables
3333

34-
<!-- TODO: Document -->
34+
To enable files to be uploaded to S3-compatible storage, the following environment variables must be set:
35+
36+
- `ENABLE_UPLOAD`: 1 to enable, 0 to disable
37+
- `BUCKET_REGION`:
38+
- `BUCKET_NAME`
39+
- `BUCKET_ACCESS_KEY_ID`
40+
- `BUCKET_ACCESS_KEY_SECRET`
41+
42+
To make this easier, the project uses [`python-dotenv`](https://github.com/theskumar/python-dotenv) to load environment variables from a config file.
43+
For local development, create a file called `.env.local`, which will be used by default.
44+
You can change which file is loaded setting the environment variable `APP_ENV`.
45+
For example the tests set `APP_ENV=test`, which loads variables from `.env.test`.
3546

3647
### Run app
3748

0 commit comments

Comments
 (0)