Skip to content

Commit aad8a65

Browse files
committed
Added docs in readme file
1 parent dfea00b commit aad8a65

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ docker run -p 8080:8080 -e 'GITHUB_OAUTH_KEY=YOURKEY' \
4545
Or to use your GitHub personal access token, you can just set `GITHUB_API_TOKEN`.
4646

4747

48+
## S3 buckets
49+
Files in S3 buckets can be access by their s3 uri like `s3://bucket/path/to/key`. This works directly for public buckets. If you want to access private buckets, you need to provide the s3 authentication credentials to the docker container or in your environment.
50+
For the docker container this can be done by setting the [environment variables](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#environment-variables) with `-e AWS_ACCESS_KEY_ID=my_secret_id -e AWS_SECRET_ACCESS_KEY=my_secret_key`.
51+
Or you can provide the [shared credentials file](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#shared-credentials-file) to the user running the nbviewer (in docker with a volume).
52+
4853
## GitHub Enterprise
4954

5055
To use nbviewer on your own GitHub Enterprise instance you need to set `GITHUB_API_URL`.

0 commit comments

Comments
 (0)