diff --git a/src/SUMMARY.md b/src/SUMMARY.md index e724b7945a6fb8cf9c75077786d2bf464dd32cc3..7260dc5783aab3f22b4e320157c88a3859768a95 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -8,6 +8,7 @@ - [Profiles](Profiles.md) - [Usage](usage/README.md) - [Shared Folders](usage/SharedFolders.md) + - [Links](usage/Links.md) - [Instructors](instructors/README.md) - [New Courses](instructors/PreperationNewCourses.md) - [Statistics](Statistics.md) diff --git a/src/usage/Links.md b/src/usage/Links.md new file mode 100644 index 0000000000000000000000000000000000000000..c5c447c62b7d090d8f41645d60025511997403c9 --- /dev/null +++ b/src/usage/Links.md @@ -0,0 +1,57 @@ +# 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