Jupydoc is a basic collection of tools to build and run a minimal Jupyter server in a Docker container meant to run on your local computer or laptop. Along with it comes a script jl.sh which manages the starting, administration and killing of active kernels. jl.sh would be started from the command line in a given directory and the current directory as well as a link to the $HOME directory will appear in the jupyter server. The script also allows command line login to the server machine, and it allows to launch a vnc server. To use that login to the docker container and type jl_vncserver to launch vncserver.
- It is assumed that you have a working Docker installation on your computer. Check with the usual
docker run hello-worldcommand. - Make the Docker image
jupydoc:latestwith themake releasecommand. - Ideally place the
jl.shscript in your~/bindirectory, or wherever you keep you command line executable, so that it can be executed from every directory.~/binor equivalent is the directory that you would have added to your$PATHvariable in your.bashrcor equivalent (.zshrcor~/.alias) - Whenever you want to launch the JupyterLab server in a directory just launch the
jl.shscript.
If you already have a couple Docker containers going you would see something like this:
Starting Jupyter Lab in Docker...
Existing containers:
0: Log in (0) | Open in Chrome (00) | Remove (000) - jd_p561 (Port: 8889)
1: Log in (1) | Open in Chrome (11) | Remove (111) - jd_tmp (Port: 8888)
Choose an action, 'new' to start a new container, or 'killall' to remove all [new]:
Where jd_xxx are the names of the running Docker containers.
- push tags, commit latest version and make tag option a documented feature
- add a
--helpoption to thejl.shscript - we can only have one vnc session at a time. We should be able to have multiple sessions.