WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/source/configuration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Configuration

User Settings
-----------------

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)


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
Expand Down
Binary file added docs/source/images/rtc_user_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 18 additions & 3 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,24 @@ pip install jupyter-collaboration
```

The new collaborative editing feature enables collaboration in real-time
between multiple clients without user roles. When sharing the URL of a
document to other users, they will have access to the same environment you
are working on (they can e.g. write and execute the cells of a notebook).
between multiple clients without user roles.

Sharing Notebooks
-----------------

To share a notebook with collaborators:

1. Click the **Share** button in the top-right corner
2. 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.

**Notes:**

- For network access, share your machine's IP address or use ``--ip=0.0.0.0`` for easier configuration
- Set a custom token with ``--LabApp.token=<your-token>`` to simplify the URL
- For remote access, use a tunnel service like [ngrok](<https://ngrok.com/>)
- Exposing your server publicly can pose security risks

Moreover, you can see the cursors from other users with an anonymous
username, a username that will disappear in a few seconds to make room
Expand Down
Loading