Skip to content

Commit 91fb9f0

Browse files
committed
update docs
1 parent f74b633 commit 91fb9f0

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ for example: `~/.jupyter/jupyter_notebook_config.py`, and specify your long-term
3636
```python
3737
c = get_config()
3838

39-
c.DrivesConfig.access_key_id = "<AWS Access Key ID / IAM Access Key ID>"
40-
c.DrivesConfig.secret_access_key = "<AWS Secret Access Key / IAM Secret>"
41-
c.DrivesConfig.session_token = "<AWS Session Token / IAM Session Token>"
39+
c.DrivesConfig.access_key_id = "<Drives Access Key ID / IAM Access Key ID>"
40+
c.DrivesConfig.secret_access_key = "<Drives Secret Access Key / IAM Secret>"
41+
c.DrivesConfig.session_token = "<Drives Session Token / IAM Session Token>"
4242
```
4343

4444
### Custom credentials file path
@@ -51,13 +51,25 @@ c = get_config()
5151
c.DrivesConfig.custom_credentials_path = "path/to/file/containing/credentials"
5252
```
5353

54+
### Environment variables
55+
56+
The credentials can also be set through environment variables that will be automatically extracted.
57+
58+
````bash
59+
export JP_DRIVES_PROVIDER="<Drives provider e.g.: s3, gcs>"
60+
export JP_DRIVES_ACCESS_KEY_ID="<Drives Access Key ID>"
61+
export JP_DRIVES_SECRET_ACCESS_KEY="<Drives Secret Access Key>"
62+
export JP_DRIVES_SESSION_TOKEN="<Drives Session Token (optional)>"
63+
export JP_DRIVES_CUSTOM_CREDENTIALS_PATH="<Path to local file which contains credentials (optional)>"
64+
65+
5466
## Uninstall
5567

5668
To remove the extension, execute:
5769

5870
```bash
5971
pip uninstall jupyter_drives
60-
```
72+
````
6173
6274
## Troubleshoot
6375

0 commit comments

Comments
 (0)