diff --git a/docs/source/configuration.md b/docs/source/configuration.md index 6161d298..6dfc443d 100644 --- a/docs/source/configuration.md +++ b/docs/source/configuration.md @@ -1,5 +1,23 @@ # Configuration +User Settings +----------------- + +The user identity is managed by `jupyter-server` and is configurable starting from `jupyter-server` v2.17.0 and `jupyter-collaboration` v4.1.0. + +To change your username, display name, or color: + +1. Click the **Collaboration** icon in the left sidebar. +2. In the **User Info** section, click your user icon. +3. Edit your details in the form that appears. + +![User settings](images/rtc_user_settings.png) + +> **Note**: This functionality works only for standalone servers and is not supported in JupyterHub. + +Storage Configuration +--------------------- + By default, any change made to a document is saved to disk in an SQLite database file called `.jupyter_ystore.db` in the directory where JupyterLab was launched. This file helps in preserving the timeline of documents, for instance between JupyterLab sessions, or when a user diff --git a/docs/source/images/rtc_user_settings.png b/docs/source/images/rtc_user_settings.png new file mode 100644 index 00000000..f2498dec Binary files /dev/null and b/docs/source/images/rtc_user_settings.png differ diff --git a/docs/source/index.md b/docs/source/index.md index b6f6a403..c7c81ea6 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -59,6 +59,19 @@ message indicating that the file was modified by someone else, and asking if you your changes or revert to the saved content. There cannot be any conflict, everyone works in sync on the same document. +Sharing Notebooks +----------------- + +To share a notebook with collaborators: + +1. Click the **Share** button in the top-right corner +2. Check "Include token in URL" if sharing with non-authenticated users +3. Copy the generated URL and send it to your collaborators + +Collaborators will have full access to your JupyterLab environment, including the ability to edit and execute cells. + +> **Note**: For running a public server, refer to the [Jupyter Server documentation](https://jupyter-server.readthedocs.io/en/latest/operators/public-server.html#running-a-public-notebook-server). + ```{toctree} :maxdepth: 1