You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/plugins/auth.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
The auth plugin has a special place because almost every other plugin depends on it for security reasons. It is possible to use any auth plugin as long as it follows a defined [API](./#api). Jupyverse comes with three auth plugins: [fps-noauth](./#fps-noauth), [fps-auth](./#fps-auth) and [fps-auth-fief](./#fps-auth-fief).
1
+
The auth plugin has a special place because almost every other plugin depends on it for security reasons. It is possible to use any auth plugin as long as it follows a defined [API](#api). Jupyverse comes with three auth plugins: [fps-noauth](#fps-noauth), [fps-auth](#fps-auth) and [fps-auth-fief](#fps-auth-fief).
Copy file name to clipboardExpand all lines: docs/usage/multi_user.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,11 @@ Jupyverse must then be launched in collaborative mode:
10
10
```bash
11
11
jupyverse --set frontend.collaborative=true
12
12
```
13
-
The collaborative mode will handle users through the [auth plugin](../../plugins/auth) you have installed, which will provide user identity.
13
+
The collaborative mode will handle users through the [auth plugin](../plugins/auth.md) you have installed, which will provide user identity.
14
14
15
15
## Identity provider
16
16
17
-
The real power of collaborative editing comes with proper user authentication and authorization. Jupyverse comes with several "auth plugins", that will be described below, but you can implement your own. It just has to follow a defined [API](../../plugins/auth/#api).
17
+
The real power of collaborative editing comes with proper user authentication and authorization. Jupyverse comes with several "auth plugins", that will be described below, but you can implement your own. It just has to follow a defined [API](../plugins/auth.md#api).
18
18
19
19
### Using fps-auth
20
20
@@ -24,11 +24,11 @@ It can be enabled by launching:
This uses the token authentication, the same as described in the [single user mode](../single_user/#token-authentication). This means that users don't get a "real" identity, since all they provide is the shared token. For this reason, we call them "anonymous users".
27
+
This uses the token authentication, the same as described in the [single user mode](single_user.md#token-authentication). This means that users don't get a "real" identity, since all they provide is the shared token. For this reason, we call them "anonymous users".
28
28
29
29
They can still be differenciated, and they will each get assigned a different name e.g. in JupyterLab, but they will all have full access to any resource. For instance, they will be able to open all documents and to execute any code.
30
30
31
-
You can also disable token authentication in collaborative mode, just as in [single user mode](../single_user/#no-authentication):
31
+
You can also disable token authentication in collaborative mode, just as in [single user mode](single_user.md#no-authentication):
@@ -43,7 +43,7 @@ In this mode, users have to be registered in a database before logging in. User
43
43
44
44
### Using fps-auth-fief
45
45
46
-
[fps-auth-fief](../../plugins/auth/#fps-auth-fief) uses [Fief](https://www.fief.dev) to authenticate users. Fief itself can be hosted in the cloud or locally, but in any case it runs a separate server, and implements OAuth2 to access Jupyverse.
46
+
[fps-auth-fief](../plugins/auth.md#fps-auth-fief) uses [Fief](https://www.fief.dev) to authenticate users. Fief itself can be hosted in the cloud or locally, but in any case it runs a separate server, and implements OAuth2 to access Jupyverse.
47
47
48
48
Fief allows to manage users using a dashboard. It supports permissions and Role-Based Access Control (RBAC).
Copy file name to clipboardExpand all lines: docs/usage/single_user.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@ The single user mode is usually meant to run e.g. JupyterLab as a desktop applic
2
2
3
3
Even though Jupyverse most often runs on a personal computer in this mode, it is not limited to this use case. For instance, if it runs on a network, it could be accessed by other people. It is thus important to limit access to the server, especially considering that Jupyter users can run potentially harmful code.
4
4
5
-
This is why Jupyverse comes with built-in authentication. Please refer to the [auth plugins](../../plugins/auth) section for more details. The authentication mechanisms below make use of the [fps-auth](../../plugins/auth/#fps-auth) plugin.
5
+
This is why Jupyverse comes with built-in authentication. Please refer to the [auth plugins](../plugins/auth.md) section for more details. The authentication mechanisms below make use of the [fps-auth](../plugins/auth.md#fps-auth) plugin.
6
6
7
7
## Token authentication
8
8
@@ -11,7 +11,7 @@ This is the default mode when launching Jupyverse, just enter in a terminal:
11
11
jupyverse --open-browser
12
12
# same as: jupyverse --set auth.mode=token --open-browser
13
13
```
14
-
This should open a new window in a browser, and load JupyterLab or Jupyter Notebook, depending on the front-end you chose to install (see [Install](../../install)).
14
+
This should open a new window in a browser, and load JupyterLab or Jupyter Notebook, depending on the front-end you chose to install (see [Install](../install.md)).
15
15
16
16
If you look at the terminal, you should see among other things:
0 commit comments