Skip to content
Snippets Groups Projects
Commit 7801c872 authored by Steffen Vogel's avatar Steffen Vogel :santa_tone2:
Browse files

add page describing different permalink options

parent d882cd28
Branches Sprint/2021-16
Tags
No related merge requests found
Pipeline #285621 passed
...@@ -8,6 +8,7 @@ ...@@ -8,6 +8,7 @@
- [Profiles](Profiles.md) - [Profiles](Profiles.md)
- [Usage](usage/README.md) - [Usage](usage/README.md)
- [Shared Folders](usage/SharedFolders.md) - [Shared Folders](usage/SharedFolders.md)
- [Links](usage/Links.md)
- [Instructors](instructors/README.md) - [Instructors](instructors/README.md)
- [New Courses](instructors/PreperationNewCourses.md) - [New Courses](instructors/PreperationNewCourses.md)
- [Statistics](Statistics.md) - [Statistics](Statistics.md)
......
# Direct Links to Notebooks and Profiles
This page shows a few examples of permanent links for accessing certain profiles or Notebooks in the Jupyter cluster.
## Individual link (contains username)
Opens a specific notebook for a specific user using the default profile (Python).
This type link is personalized due to the included username and can therefore not be shared with other users.
If there is no running server existing for the user, a new server is started.
**Schema:** `https://jupyter.rwth-aachen.de/user/{{ user_name }}/lab/tree/{{ notebook_path }}`
**Example:** https://jupyter.rwth-aachen.de/user/vzi3jsam/lab/tree/gdet3/GDET3%20Faltung%20GUI.ipynb
#### Arguments
- `user_name` your Jupyter username which is a pseudo-random 8 digit alpha numeric identfier displayed after login in the top right cormer.
- `notebook_path` and URL encoded path to the Notebook which should be opened.
## Generic link (user-redirect)
This is a generic version of the previous link which can be shared with other users.
**Schema:** `https://jupyter.rwth-aachen.de/user-redirect/lab/tree/{{ notebook_path }}`
**Example:** https://jupyter.rwth-aachen.de/user-redirect/lab/tree/gdet3/GDET3%20Faltung%20GUI.ipynb
## Spawn specific profile
This link to spawn a specific profile.
**Note:** If a server is already running with a different profile, no action will be taken.
#### Arguments
- `profile_slug` a short alpha numeric identifier for the profile. Please take a look at the [profile list](Profiles.md) for available profiles.
**Schema:** `https://jupyter.rwth-aachen.de/hub/spawn?profile={{ profile_slug }}`
**Example:** https://jupyter.rwth-aachen.de/hub/spawn?profile=gdet3
### Specify username and server name
Using this slighly extended version, a named server for a specific user can be spawned.
Please note that user impersonalization is only available for administrators.
A normal user can start up to 10 named servers. E.g. for using several profiles in parallel
**Schema:** `https://jupyter.rwth-aachen.de/hub/spawn/{{ user_name }}/{{ server_name }}?profile={{ profile_slug }}`
**Example:** https://jupyter.rwth-aachen.de/hub/spawn/vzi3jsam/my_et3_server?profile=gdet3
#### Arguments
- `server_name` is a alpha numeric identifier for the named server
## Spawn specific profile and open a notebook
**Schema:** `https://jupyter.rwth-aachen.de/hub/spawn?profile={{ profile_slug }}&next=/user-redirect/lab/tree/{{ notebook_path }}`
**Example:** https://jupyter.rwth-aachen.de/hub/spawn?profile=gdet3&next=/user-redirect/lab/tree/gdet3/GDET3%20Faltung%20GUI.ipynb
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment