Merge pull request ipython#29 from rgbkrk/multiuser

rgbkrk · rgbkrk · commit 38a5f2572f0f · 2015-04-08T14:18:17.000-04:00
Explore multi user notebook launch modes.
diff --git a/examples/Notebook/Running the Notebook Server.ipynb b/examples/Notebook/Running the Notebook Server.ipynb
@@ -315,6 +315,24 @@
     "```"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Known issues"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "When behind a proxy, especially if your system or browser is set to autodetect the proxy, the notebook web application might fail to connect to the server's websockets, and present you with a warning at startup. In this case, you need to configure your system not to use the proxy for the server's address.\n",
+    "\n",
+    "For example, in Firefox, go to the Preferences panel, Advanced section,\n",
+    "Network tab, click 'Settings...', and add the address of the notebook server\n",
+    "to the 'No proxy for' field."
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -340,22 +358,123 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Known issues"
+    "# Multi-User Notebook Servers"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "When behind a proxy, especially if your system or browser is set to autodetect the proxy, the notebook web application might fail to connect to the server's websockets, and present you with a warning at startup. In this case, you need to configure your system not to use the proxy for the server's address.\n",
+    "## JupyterHub"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "JupyterHub is a multi-user server that manages and proxies multiple instances of the single-user IPython/Jupyter Notebook server.\n",
     "\n",
-    "For example, in Firefox, go to the Preferences panel, Advanced section,\n",
-    "Network tab, click 'Settings...', and add the address of the notebook server\n",
-    "to the 'No proxy for' field."
+    "<img src=\"https://c2a32ff18d23c8f567f0-e44b0df73868b5d567b1e58e01681d15.ssl.cf5.rackcdn.com/2015-03-24-deploying-jupyterhub-for-education/jupyterhub-9efc59baf33d2640641cb4a1fd9145ff.gif\" width=\"800px\" />\n",
+    "\n",
+    "### Components\n",
+    "\n",
+    "* multi-user Hub (tornado process)\n",
+    "* configurable http proxy (node-http-proxy)\n",
+    "* multiple single-user IPython notebook servers (Python/IPython/tornado)\n",
+    "\n",
+    "#### [Configurable Proxy](https://github.com/jupyter/configurable-http-proxy)\n",
+    "\n",
+    "* Based on node-http-proxy\n",
+    "* Proxy routes to localhost, external IPs, etc.\n",
+    "\n",
+    "```\n",
+    "/user/123/ -> 127.0.0.1:56790\n",
+    "```\n",
+    "\n",
+    "* Provides an administrative API for adding routes\n",
+    "\n",
+    "```\n",
+    "POST /api/routes/[:path]\n",
+    "```\n",
+    "\n",
+    "#### [JupyterHub](https://github.com/jupyter/jupyterhub)\n",
+    "\n",
+    "* Hub spawns proxy\n",
+    "* Proxy forwards ~all requests to hub by default\n",
+    "* Hub handles login, and spawns single-user servers on demand\n",
+    "* Hub configures proxy to forward url prefixes to single-user servers\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Authentication models\n",
+    "\n",
+    "* PAM/Unix (Default)\n",
+    "* [GitHub OAuth](https://github.com/jupyter/oauthenticator) - Demo at demohub.jupyter.org\n",
+    "\n",
+    "This is extensible enough to implement other authentication methods, the simplest being any involving OAuth (follow the GitHub OAuthenticator for a skeleton)."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Spawners\n",
+    "\n",
+    "By default, notebook servers are spawned in the context of the user as a process on the host machine. One alternative for spawning is the [DockerSpawner](https://github.com/jupyter/dockerspawner) which runs each user in their own environment inside a Docker container.\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Real world implementations of JupyterHub\n",
+    "\n",
+    "The Computational Models class at UC Berkeley ran a JupyterHub installation for ~220 students in Winter/Spring of 2015.\n",
+    "\n",
+    "* Docker Spawner\n",
+    "* Multiple compute nodes\n",
+    "* GitHub Authentication\n",
+    "* NFS backed for student data, assignments, notebooks, etc.\n",
+    "\n",
+    "![](https://c2a32ff18d23c8f567f0-e44b0df73868b5d567b1e58e01681d15.ssl.cf5.rackcdn.com/2015-03-24-deploying-jupyterhub-for-education/setup-2e74d935ee0c874e66a9b53359493ceb.png)\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## tmpnb\n",
+    "\n",
+    "tmpnb is a temporary notebook system. Visit [try.jupyter.org](https://try.jupyter.org) for a demo.\n",
+    "\n",
+    "Similar to JupyterHub with the DockerSpawner, tmpnb uses a proxy to route to notebook servers. The difference is that there is no login and notebook servers get deleted after a period of (configurable) inactivity.\n",
+    "\n",
+    "<img src=\"https://cloud.githubusercontent.com/assets/836375/5911140/c53e3978-a587-11e4-86a5-695469ef23a5.png\" width=\"800px\" />\n"
    ]
   }
  ],
- "metadata": {},
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.4.3"
+  }
+ },
  "nbformat": 4,
  "nbformat_minor": 0
-}
+}
