doc: Update readme
Update README with usage and documentation of exposed volumes and notes about the security of this container.
This commit is contained in:
parent
5c41384e17
commit
1a93cf176a
24
README.md
24
README.md
|
@ -1,3 +1,23 @@
|
|||
# jupyter-alpine
|
||||
# docker-jupyter-simple
|
||||
|
||||
Very, very simple container for running JupyterLab (+Notebook, +Voila).
|
||||
|
||||
Runs whatever the latest stable Python is, exclusively runs inside a virtualenv, has NodeJS installed using nodeenv inside the virtualenv.
|
||||
|
||||
## Using
|
||||
|
||||
docker volume create jupyter-data
|
||||
docker volume create jupyter-conf
|
||||
docker run --rm -p 8888:8888 -v jupyter-data:/data -v jupyter-conf:/root/.jupyter maffsie/jupyter-simple:latest
|
||||
|
||||
The JupyterLab web interface is exposed on port 8888. No packages are installed by default, but can easily be installed using `pip`.
|
||||
|
||||
## Volumes
|
||||
|
||||
* `/data` - where all user data is stored
|
||||
* `/root/.jupyter` - where all config and state is stored
|
||||
|
||||
## Security
|
||||
|
||||
This container deliberately does not have any security considerations. It is built as root, runs as root, and I have no interest in changing that. This is not because I believe root is fine, or because I don't care about security, but instead is because this container was created in order to have a lowest-friction Jupyter setup. The existing docker containers do not have a clearly defined usage, for whatever reason.
|
||||
|
||||
Alpine Linux-based container with an extremely basic JupyterLab (and related packages) setup
|
Loading…
Reference in New Issue