Skip to content

Commit 883cf3f

Browse files
authored
Merge pull request #278 from painebot/tkp/fsspec
Add docs about choosing backend, fixes #270
2 parents d5d5212 + 17ef63d commit 883cf3f

3 files changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ Add the following to your `jupyter_server_config.json`:
4343
}
4444
```
4545

46+
Resources can then be added via the `Settings -> Settings Editor`.
47+
48+
![](https://raw.githubusercontent.com/jpmorganchase/jupyter-fs/main/docs/img/settings.png)
49+
4650

4751
## Simple use (no auth/credentials)
4852

@@ -137,6 +141,14 @@ export FSSPEC_S3_KEY=<YOUR KEY>
137141
export FSSPEC_S3_SECRET=<YOUR SECRET>
138142
```
139143

144+
## Choosing the backend
145+
146+
Your resource can include a `"type"` field, set to either `pyfs` or `fsspec`.
147+
The default is `pyfs`.
148+
This field can be configured via JSON Settings or graphically.
149+
150+
![](https://raw.githubusercontent.com/jpmorganchase/jupyter-fs/main/docs/img/settings_choose_backend.png)
151+
140152
## The filesystem url
141153

142154
### PyFilesystem

docs/img/settings.png

388 KB
Loading
34 KB
Loading

0 commit comments

Comments
 (0)