Skip to content

Commit

Permalink
Merge pull request #359 from manics/readme-warn-net
Browse files Browse the repository at this point in the history
README: warn about unlimited local network access
  • Loading branch information
consideRatio authored Dec 15, 2022
2 parents 72e7dcb + ac76d02 commit ade470c
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,24 @@ The primary use cases are:
[The documentation](https://jupyter-server-proxy.readthedocs.io/)
contains information on installation & usage.

## Security warning

Jupyter Server Proxy is often used to start a user defined process listening to
some network port (e.g. http://localhost:4567) for a user starting a Jupyter Server
that only that user has permission to access. The user can then access the
started process proxied through the Jupyter Server.

For safe use of Jupyter Server Proxy, you should ensure that the process started
by Jupyter Server proxy can't be accessed directly by another user and bypass
the Jupyter Server's authorization!

A common strategy to enforce access proxied via Jupyter Server is to start
Jupyter Server within a container and only allow network access to the Jupyter
Server via the container.

For more insights, see [Ryan Lovetts comment about
it](https://github.com/jupyterhub/jupyter-server-proxy/pull/359#issuecomment-1350118197).

## Install

### Requirements
Expand Down

0 comments on commit ade470c

Please sign in to comment.