{"id":20279912,"url":"https://github.com/sernst/jupyter-docker","last_synced_at":"2026-06-04T18:31:09.784Z","repository":{"id":147690680,"uuid":"63430014","full_name":"sernst/Jupyter-Docker","owner":"sernst","description":"Convenience scripting for managing a local Jupyter docker image for running notebooks ","archived":false,"fork":false,"pushed_at":"2017-01-13T16:48:35.000Z","size":9,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-01-14T07:13:35.240Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sernst.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-15T14:58:04.000Z","updated_at":"2016-07-15T15:47:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"cb90fa3c-1764-426e-8d22-504fecee15c3","html_url":"https://github.com/sernst/Jupyter-Docker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sernst%2FJupyter-Docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sernst%2FJupyter-Docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sernst%2FJupyter-Docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sernst%2FJupyter-Docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sernst","download_url":"https://codeload.github.com/sernst/Jupyter-Docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241773256,"owners_count":20018064,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T13:33:43.300Z","updated_at":"2025-03-04T02:41:45.698Z","avatar_url":"https://github.com/sernst.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jupyter-Docker\n\nThe jupyter-docker python script is a convenience wrapper around the docker\ncommands needed to manage a\n[All Spark Notebook](https://github.com/jupyter/docker-stacks/tree/master/all-spark-notebook)\ndocker container for running a local Jupyter notebooks.\n\n## Installation\n\nPrior to using the command, you must have Docker installed on your system and \nbe running the docker daemon. This can be achieved easily by installing the\ndocker application for your specific platform:\n\n * [Docker for Mac](http://www.docker.com/products/docker#/mac)\n * [Docker for Windows](http://www.docker.com/products/docker#/windows)\n * [Docker for Linux](http://www.docker.com/products/docker#/linux)\n\nAfter downloading and installing Docker for your platform, make sure that you\nrun it to start the docker daemon needed by the jupyter-docker script.\n\n## Basic Usage\n\nA command can be invoked with python:\n\n    $ python jupyter-docker [COMMAND]\n    \nor by itself:\n\n    $ jupyter-docker [COMMAND]\n    \nif you add executable permissions to the jupyter-docker script file and are\nusing a bash (or compatible) shell environment.\n\n*Windows Usage Note:* On windows, the python command is not usually made \navailable. Instead you will need to specify an absolute path to the python exe\nsuch as:\n\n    $ C:\\Python3.5\\python.exe jupyter-docker [COMMAND]\n    \nwhere the path to your python.exe depends on your system.\n\n## First Use\n\nBefore you can run the jupyter container, the source files (i.e. docker image) \nneed to be installed on your system. To do that execute the 'update' command:\n\n    $ python jupyter-docker update\n    \nThis single command will take care of the installation process for you. \nHowever, the files are large (5GB) and it will take some time to download.\n\nWhen you execute the update command after the docker image (source files) are\nalready installed, the docker image (source files) will be updated if any \nupdates are available. It is recommended that you run this periodically to \nmake sure you are running the latest versions of all the software.\n\n## Available Commands\n\nThe script has four available commands:\n\n  * __start:__ starts a running container with any specified arguments. Any \n        existing container will be shut down and replaced by a new one.\n  * __stop:__ stops the currently running container if one exists\n  * __update:__ installs or updates the docker image on which the container is \n        run. This step will run implicitly if a' start command is issued before \n        the image has been installed.\n  * __open:__ opens a bash terminal in the currently running container. This \n        gives you command line access for running python or pyspark scripts \n        outside of a notebook environment\n\n## Notebooks\n\nOnce you have installed the docker image using the *update* command, you can\nstart the container running with:\n\n    $ python jupyter-docker start\n    \nA container running jupyter will be started. Your home directory is also \nattached to the container with the folder name 'root'. This gives notebooks \naccess to the files in your home directory. \n\nFor notebooks run using an Anaconda Python 3 environment:\n\n    http://localhost:8888\n    \nFor notebooks run using Anaconda Python 2 environment:\n\n    http://localhost:8889\n\nWhen finished working, you shut the container down with the command:\n\n    $ python jupyter-docker stop\n    \n# Advanced Usage\n\n## Terminal Access\n\nIf you would like command line access to the running container, use the command:\n\n    $ python jupyter-docker open\n    \nA bash shell will be opened in the container. You can use this to conda install\nadditional packages, run scripts from the command line or otherwise modify the\ncontainer environment where the notebooks are running.\n\n*Note:* Any changes you make to the container will be lost when you stop the \ncontainer.\n\n## Additional Command Flags\n\nThe *start* command accepts flags to change the default behavior of the \ncontainer.\n\n   * __--directory__ Use this flag to specify an alternate directory to mount\n        to the container instead of your home directory.\n   * __--port__ Specifies the localhost port (default 8888) for the jupyter\n        notebook server running in an Anaconda 3 environment.\n   * __--port2__ Specifies the localhost port (default 8889) for the jupyter\n        notebook server running in an Anaconda 2 environment.\n   \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsernst%2Fjupyter-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsernst%2Fjupyter-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsernst%2Fjupyter-docker/lists"}