Skip to content

Commit 6df5c7f

Browse files
manicsconsideRatio
andauthored
Expand README warning
Co-authored-by: Erik Sundell <[email protected]>
1 parent a0fc561 commit 6df5c7f

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,25 @@ The primary use cases are:
3232
[The documentation](https://jupyter-server-proxy.readthedocs.io/)
3333
contains information on installation & usage.
3434

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).
3754

3855
## Install
3956

0 commit comments

Comments
 (0)