File tree Expand file tree Collapse file tree 1 file changed +19
-2
lines changed Expand file tree Collapse file tree 1 file changed +19
-2
lines changed Original file line number Diff line number Diff line change @@ -32,8 +32,25 @@ The primary use cases are:
32
32
[ The documentation] ( https://jupyter-server-proxy.readthedocs.io/ )
33
33
contains information on installation & usage.
34
34
35
- ** Warning:** Jupyter Server Proxy is designed for containerised environments.
36
- It has access to all local network services that the user has access to.
35
+ ## Security warning
36
+
37
+ Jupyter Server Proxy is often used to start a user defined process listening to
38
+ some network port (http://localhost:4567 ) for a user starting a Jupyter Server
39
+ that only that user has permission to access. The user can then access the
40
+ started process proxied through the Jupyter Server.
41
+
42
+ For safe use of Jupyter Server Proxy, you should ensure that the process started
43
+ by Jupyter Server proxy can't be accessed directly by another user and bypass
44
+ the Jupyter Server's authorization!
45
+
46
+ A common strategy to enforce access proxied via Jupyter Server is to start
47
+ Jupyter Server within a container and only allow network access to the Jupyter
48
+ Server through to the container. Another strategy is to communicate with the
49
+ started process through a unix socket as proposed in [ Pull request
50
+ #337 ] ( https://github.com/jupyterhub/jupyter-server-proxy/pull/337 ) .
51
+
52
+ For more insights, see [ Ryan Lovetts comment about
53
+ it] ( https://github.com/jupyterhub/jupyter-server-proxy/pull/359#issuecomment-1350118197 ) .
37
54
38
55
## Install
39
56
You can’t perform that action at this time.
0 commit comments