Skip to content

Commit 03311c0

Browse files
committed
Added S3 creds info to readme
1 parent 46b3d03 commit 03311c0

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,20 @@ OIDC_CLIENT_CONFIG = {
2424
}
2525
```
2626

27+
#### Add S3 Config
28+
An S3 bucket is used to store files that users upload (currently just for major project submissions). In order to have this work properly, you need to provide some credentials to the app.
29+
30+
There are 2 ways that you can get the needed credentials.
31+
1. Reach out to an RTP
32+
2. Create a bucket using [DEaDASS](https://deadass.csh.rit.edu/), and the site will give you the credentials you need.
33+
34+
```py
35+
S3_URI = env.get("S3_URI", "https://s3.csh.rit.edu")
36+
S3_BUCKET_ID = env.get("S3_BUCKET_ID", "major-project-media")
37+
AWS_ACCESS_KEY_ID = env.get("AWS_ACCESS_KEY_ID", "")
38+
AWS_SECRET_ACCESS_KEY = env.get("AWS_SECRET_ACCESS_KEY", "")
39+
```
40+
2741
#### Database
2842
You can either develop using the dev database, or use the local database provided in the docker compose file
2943

0 commit comments

Comments
 (0)