Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fscm/docker-jupyter
Docker recipe to build an Jupyter Notebook image
https://github.com/fscm/docker-jupyter
docker docker-image dockerfile jupyter jupyter-notebook jupyterlab python3
Last synced: 9 days ago
JSON representation
Docker recipe to build an Jupyter Notebook image
- Host: GitHub
- URL: https://github.com/fscm/docker-jupyter
- Owner: fscm
- License: mit
- Created: 2019-10-10T16:39:13.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-01-03T15:58:32.000Z (almost 3 years ago)
- Last Synced: 2023-10-20T06:59:56.708Z (about 1 year ago)
- Topics: docker, docker-image, dockerfile, jupyter, jupyter-notebook, jupyterlab, python3
- Language: Shell
- Size: 33.2 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.build.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Jupyter for Docker
Docker image with Jupyter Notebook.
## Synopsis
This script will create a Docker image with Jupyter Notebook installed and
with all of the required initialization scripts.
The Docker image resulting from this script should be the one used to
instantiate a Jupyter application.
## Getting Started
There are a couple of things needed for the script to work.
### Prerequisites
Docker, either the Community Edition (CE) or Enterprise Edition (EE), needs to
be installed on your local computer.
#### Docker
Docker installation instructions can be found
[here](https://docs.docker.com/install/).
### Usage
In order to create a Docker image using this Dockerfiles you need to run the
`docker` command with a few options.
```shell
docker image build --force-rm --no-cache --quiet --file /Dockerfile --tag /:
```
* `` - *[required]* The user that will own the container image (e.g.: "johndoe").
* `` - *[required]* The container name (e.g.: "jupyter").
* `` - *[required]* The container tag (e.g.: "latest").
* `` - *[required]* The location of the Dockerfile folder.
* `` - *[required]* The variant that is being build (`centos` or `debian`).
A build example:
```shell
docker image build --force-rm --no-cache --quiet --file debian/Dockerfile --tag johndoe/my_jupyter:debian .
```
To clean any _`none`_ image(s) left by the build process the following
command can be used:
```shell
docker image rm `docker image ls --filter "dangling=true" --quiet`
```
You can also use the following command to achieve the same result:
```shell
docker image prune -f
```
### Add Tags to the Docker Image
Additional tags can be added to the image using the following command:
```shell
docker image tag /:
```
### Push the image to Docker Hub
After adding an image to Docker, that image can be pushed to a Docker
registry... Like Docker Hub.
Make sure that you are logged in to the service.
```shell
docker login
```
When logged in, an image can be pushed using the following command:
```shell
docker image push /:
```
Extra tags can also be pushed.
```shell
docker image push /:
```
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request
Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for more details on how
to contribute to this project.
## Versioning
This project uses [SemVer](http://semver.org/) for versioning. For the versions
available, see the [tags on this repository](https://github.com/fscm/docker-jupyter/tags).
## Authors
* **Frederico Martins** - [fscm](https://github.com/fscm)
See also the list of [contributors](https://github.com/fscm/docker-jupyter/contributors)
who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE)
file for details