Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Scs #6

Open
wants to merge 89 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
89 commits
Select commit Hold shift + click to select a range
db3f9ac
added r-notebook
whatevergeek Feb 22, 2017
073abe1
introduction and install
oliverxchen Feb 26, 2017
ebe88b5
update mac installation instructions
oliverxchen Feb 26, 2017
f96b626
running docker
oliverxchen Feb 26, 2017
17cdee0
Merge pull request #1 from DataKind-SG/start-main-readme
whatevergeek Feb 27, 2017
27e86fe
Updated README to add a note on using Docker Toolbox & R Notebook and…
Physicist91 Mar 1, 2017
8ce9d3d
Update Dockerfile
whatevergeek Mar 12, 2017
cec52a0
Update requirements.txt
whatevergeek Mar 12, 2017
1b8b498
Update Dockerfile
whatevergeek Mar 12, 2017
ec4a06c
Update Dockerfile
whatevergeek Mar 12, 2017
be27079
Update README with Quay.io explanation
puikwan Mar 13, 2017
f6bff7e
Update Dockerfile
whatevergeek Mar 13, 2017
28c837b
Merge pull request #3 from DataKind-SG/start-main-readme
whatevergeek Mar 13, 2017
4a9906b
Merge pull request #2 from Physicist91/master
whatevergeek Mar 13, 2017
83ebdd6
Updated workshop steps
Mar 13, 2017
ce84234
Updated hyperlinks
Mar 13, 2017
f324c34
Update readme.md
whatevergeek Mar 14, 2017
0506d1e
Update readme.md
whatevergeek Mar 14, 2017
bacad67
add workflow to readme
oliverxchen Mar 15, 2017
66dffc0
Merge pull request #4 from DataKind-SG/workflow
whatevergeek Mar 15, 2017
e8ff5e2
change workflow to adding new libraries
oliverxchen Mar 15, 2017
e7d3a61
Merge pull request #5 from DataKind-SG/name-change
whatevergeek Mar 15, 2017
50ab773
Update readme.md
whatevergeek Mar 15, 2017
f8c94d8
addresses python library requirements for #6
oliverxchen Mar 19, 2017
12d5b4c
tag the base image. Successfully build locally. (#6)
oliverxchen Mar 19, 2017
84abb2d
Merge pull request #7 from DataKind-SG/freeze
whatevergeek Mar 19, 2017
03298a7
Added spacy to requirements.txt.
Physicist91 Mar 25, 2017
b938b44
Added scs and spacy
Physicist91 Mar 25, 2017
0a4115b
Merge branch 'scs' of https://github.com/DataKind-SG/contain-yourself…
Physicist91 Mar 25, 2017
25e8acf
restore base version.
Physicist91 Mar 25, 2017
b7a4436
Added new r-notebook for O'joy
aki261289 Mar 25, 2017
e6b2dd1
Merge pull request #8 from DataKind-SG/scs
whatevergeek Mar 25, 2017
2e2e258
Added Red Cross Blood Program
Mar 25, 2017
d93e53d
Merge pull request #9 from DataKind-SG/Ojoy
whatevergeek Mar 25, 2017
a3a8a1c
Merge pull request #10 from DataKind-SG/redcross
whatevergeek Mar 25, 2017
fb23706
change readme's for org folders
oliverxchen Mar 25, 2017
92044e3
Merge pull request #12 from DataKind-SG/org-readmes
whatevergeek Mar 25, 2017
89ac49c
Dockerfile
rwchan13 Apr 3, 2017
181cdaa
Merge pull request #13 from DataKind-SG/rwchan13-patch-1
whatevergeek Apr 3, 2017
d4bcf4d
added r notebook to redcross
Apr 4, 2017
9aca12f
Merge pull request #14 from DataKind-SG/rc
whatevergeek Apr 4, 2017
73d351b
Delete rstudio
rwchan13 Apr 5, 2017
9649238
Merge pull request #15 from DataKind-SG/rwchan13-patch-2
whatevergeek Apr 5, 2017
06ea156
Create Dockerfile
rwchan13 Apr 5, 2017
8c78478
Merge pull request #17 from DataKind-SG/rwchan13-patch-4
whatevergeek Apr 5, 2017
18409a1
Added shiny and data.table libraries
aki261289 Apr 5, 2017
1fb696c
Merge pull request #18 from DataKind-SG/ojoy
whatevergeek Apr 5, 2017
2a9017b
Add tag to r-notebook base image in Dockerfile
Physicist91 Apr 6, 2017
1853b6a
Modified FROM in R-notebook to FROM jupyter/minimal-notebook:9e056d61…
aki261289 Apr 6, 2017
6695d25
Reverted rstudio dockerfile to original code
aki261289 Apr 6, 2017
a87544c
Modified FROM in R-notebook to FROM jupyter/minimal-notebook:9e056d61…
aki261289 Apr 6, 2017
a207589
Now the versions.
rwchan13 Apr 7, 2017
8cdbd83
from my phone!
oliverxchen Apr 7, 2017
fc80b7c
Merge pull request #19 from DataKind-SG/ojoy
whatevergeek Apr 7, 2017
f9c159d
Merge branch 'master' into rwchan13-patch-5
whatevergeek Apr 7, 2017
46b269a
Merge pull request #20 from DataKind-SG/rwchan13-patch-5
whatevergeek Apr 7, 2017
2a79a9d
Merge pull request #21 from DataKind-SG/scs
whatevergeek Apr 7, 2017
1821d43
modified dockerfile
Apr 7, 2017
d9311d8
Merge pull request #22 from DataKind-SG/rc
whatevergeek Apr 7, 2017
85a3002
Added RStudio info in readme
whatevergeek Apr 7, 2017
b519870
Rstudio info in readme - corrected typo
whatevergeek Apr 7, 2017
81e7c9c
rstudio in readme - cosmetic touch
whatevergeek Apr 7, 2017
23cc1e8
Merge pull request #23 from DataKind-SG/whatevergeek-patch1
oliverxchen Apr 7, 2017
ac0c621
added folium to red cross python notebook
Apr 7, 2017
add2f36
Merge pull request #24 from DataKind-SG/rc
whatevergeek Apr 7, 2017
d0d926c
add geopy lib
Apr 8, 2017
60aa14a
Merge pull request #25 from DataKind-SG/rc
whatevergeek Apr 8, 2017
8b5ff91
Added each library as a layer to pull images faster,added two librari…
aki261289 Apr 8, 2017
51dafed
Merge branch 'master' into ojoy
whatevergeek Apr 8, 2017
0da2e8b
Merge pull request #26 from DataKind-SG/ojoy
whatevergeek Apr 8, 2017
f91bd80
added statsmodels and xgboost
Apr 8, 2017
cf0ac0f
Merge pull request #27 from DataKind-SG/rc
whatevergeek Apr 8, 2017
e1e06fd
edited xgboost version
Apr 8, 2017
8d2f816
Merge pull request #28 from DataKind-SG/rc
whatevergeek Apr 8, 2017
ce37662
Added extra libraries and modules for children society.
Physicist91 Apr 8, 2017
3911654
Merge pull request #29 from DataKind-SG/scs
whatevergeek Apr 8, 2017
7142f11
Added RStudio docker for children society.
Physicist91 Apr 9, 2017
6624474
Merge pull request #30 from DataKind-SG/scs
whatevergeek Apr 9, 2017
f83a7d8
changed single quote to double quote.
Physicist91 Apr 9, 2017
567104b
Merge pull request #31 from DataKind-SG/scs
whatevergeek Apr 9, 2017
b2254ff
added bokeh library to python notebook
Apr 9, 2017
7e8b4a8
Merge pull request #32 from DataKind-SG/rc
whatevergeek Apr 9, 2017
baed01b
Added version number and more packages
Physicist91 Apr 9, 2017
70dc3c1
fixed typo
Physicist91 Apr 9, 2017
d76e56e
Merge pull request #34 from DataKind-SG/scs
whatevergeek Apr 9, 2017
e17d3de
Added new packages, fixed version numbers of a few packages, added a …
Physicist91 Apr 9, 2017
a43d839
Merge pull request #35 from DataKind-SG/scs
whatevergeek Apr 9, 2017
2ce5f8f
Added new packages for rstudio children-society.
Physicist91 Apr 20, 2017
f7030b1
Edited to avoid redundancy in layers.
Physicist91 Apr 20, 2017
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
added r-notebook
whatevergeek committed Feb 22, 2017
commit db3f9ac81600f40fbbb8aa3849f3d8285473419b
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 2 additions & 0 deletions r-notebook/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Documentation
README.md
36 changes: 36 additions & 0 deletions r-notebook/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.
FROM jupyter/minimal-notebook

MAINTAINER Jupyter Project <jupyter@googlegroups.com>

USER root

# R pre-requisites
RUN apt-get update && \
apt-get install -y --no-install-recommends \
fonts-dejavu \
gfortran \
gcc && apt-get clean && \
rm -rf /var/lib/apt/lists/*

USER $NB_USER

# R packages
RUN conda config --add channels r && \
conda install --quiet --yes \
'r-base=3.3.2' \
'r-irkernel=0.7*' \
'r-plyr=1.8*' \
'r-devtools=1.12*' \
'r-tidyverse=1.0*' \
'r-shiny=0.14*' \
'r-rmarkdown=1.2*' \
'r-forecast=7.3*' \
'r-rsqlite=1.1*' \
'r-reshape2=1.4*' \
'r-nycflights13=0.2*' \
'r-caret=6.0*' \
'r-rcurl=1.95*' \
'r-crayon=1.3*' \
'r-randomforest=4.6*' && conda clean -tipsy
118 changes: 118 additions & 0 deletions r-notebook/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
![docker pulls](https://img.shields.io/docker/pulls/jupyter/r-notebook.svg) ![docker stars](https://img.shields.io/docker/stars/jupyter/r-notebook.svg) [![](https://images.microbadger.com/badges/image/jupyter/r-notebook.svg)](https://microbadger.com/images/jupyter/r-notebook "jupyter/r-notebook image metadata")

# Jupyter Notebook R Stack

## What it Gives You

* Jupyter Notebook 4.3.x
* Conda R v3.3.x and channel
* plyr, devtools, shiny, rmarkdown, forecast, rsqlite, reshape2, nycflights13, caret, rcurl, and randomforest pre-installed
* The [tidyverse](https://github.com/tidyverse/tidyverse) R packages are also installed, including ggplot2, dplyr, tidyr, readr, purrr, tibble, stringr, lubridate, and broom
* Unprivileged user `jovyan` (uid=1000, configurable, see options) in group `users` (gid=100) with ownership over `/home/jovyan` and `/opt/conda`
* [tini](https://github.com/krallin/tini) as the container entrypoint and [start-notebook.sh](../base-notebook/start-notebook.sh) as the default command
* A [start-singleuser.sh](../base-notebook/start-singleuser.sh) script useful for running a single-user instance of the Notebook server, as required by JupyterHub
* A [start.sh](../base-notebook/start.sh) script useful for running alternative commands in the container (e.g. `ipython`, `jupyter kernelgateway`, `jupyter lab`)
* Options for a self-signed HTTPS certificate and passwordless `sudo`

## Basic Use

The following command starts a container with the Notebook server listening for HTTP connections on port 8888 with a randomly generated authentication token configured.

```
docker run -it --rm -p 8888:8888 jupyter/r-notebook
```

Take note of the authentication token included in the notebook startup log messages. Include it in the URL you visit to access the Notebook server or enter it in the Notebook login form.

## Notebook Options

The Docker container executes a [`start-notebook.sh` script](../base-notebook/start-notebook.sh) script by default. The `start-notebook.sh` script handles the `NB_UID` and `GRANT_SUDO` features documented in the next section, and then executes the `jupyter notebook`.

You can pass [Jupyter command line options](https://jupyter.readthedocs.io/en/latest/projects/jupyter-command.html) through the `start-notebook.sh` script when launching the container. For example, to secure the Notebook server with a custom password hashed using `IPython.lib.passwd()` instead of the default token, run the following:

```
docker run -d -p 8888:8888 jupyter/r-notebook start-notebook.sh --NotebookApp.password='sha1:74ba40f8a388:c913541b7ee99d15d5ed31d4226bf7838f83a50e'
```

For example, to set the base URL of the notebook server, run the following:

```
docker run -d -p 8888:8888 jupyter/r-notebook start-notebook.sh --NotebookApp.base_url=/some/path
```

For example, to disable all authentication mechanisms (not a recommended practice):

```
docker run -d -p 8888:8888 jupyter/r-notebook start-notebook.sh --NotebookApp.token=''
```

You can sidestep the `start-notebook.sh` script and run your own commands in the container. See the *Alternative Commands* section later in this document for more information.

## Docker Options

You may customize the execution of the Docker container and the command it is running with the following optional arguments.

* `-e GEN_CERT=yes` - Generates a self-signed SSL certificate and configures Jupyter Notebook to use it to accept encrypted HTTPS connections.
* `-e NB_UID=1000` - Specify the uid of the `jovyan` user. Useful to mount host volumes with specific file ownership. For this option to take effect, you must run the container with `--user root`. (The `start-notebook.sh` script will `su jovyan` after adjusting the user id.)
* `-e GRANT_SUDO=yes` - Gives the `jovyan` user passwordless `sudo` capability. Useful for installing OS packages. For this option to take effect, you must run the container with `--user root`. (The `start-notebook.sh` script will `su jovyan` after adding `jovyan` to sudoers.) **You should only enable `sudo` if you trust the user or if the container is running on an isolated host.**
* `-v /some/host/folder/for/work:/home/jovyan/work` - Host mounts the default working directory on the host to preserve work even when the container is destroyed and recreated (e.g., during an upgrade).

## SSL Certificates

You may mount SSL key and certificate files into a container and configure Jupyter Notebook to use them to accept HTTPS connections. For example, to mount a host folder containing a `notebook.key` and `notebook.crt`:

```
docker run -d -p 8888:8888 \
-v /some/host/folder:/etc/ssl/notebook \
jupyter/r-notebook start-notebook.sh \
--NotebookApp.keyfile=/etc/ssl/notebook/notebook.key
--NotebookApp.certfile=/etc/ssl/notebook/notebook.crt
```

Alternatively, you may mount a single PEM file containing both the key and certificate. For example:

```
docker run -d -p 8888:8888 \
-v /some/host/folder/notebook.pem:/etc/ssl/notebook.pem \
jupyter/r-notebook start-notebook.sh \
--NotebookApp.certfile=/etc/ssl/notebook.pem
```

In either case, Jupyter Notebook expects the key and certificate to be a base64 encoded text file. The certificate file or PEM may contain one or more certificates (e.g., server, intermediate, and root).

For additional information about using SSL, see the following:

* The [docker-stacks/examples](https://github.com/jupyter/docker-stacks/tree/master/examples) for information about how to use [Let's Encrypt](https://letsencrypt.org/) certificates when you run these stacks on a publicly visible domain.
* The [jupyter_notebook_config.py](jupyter_notebook_config.py) file for how this Docker image generates a self-signed certificate.
* The [Jupyter Notebook documentation](https://jupyter-notebook.readthedocs.io/en/latest/public_server.html#using-ssl-for-encrypted-communication) for best practices about running a public notebook server in general, most of which are encoded in this image.


## Alternative Commands

### start-singleuser.sh

[JupyterHub](https://jupyterhub.readthedocs.io) requires a single-user instance of the Jupyter Notebook server per user. To use this stack with JupyterHub and [DockerSpawner](https://github.com/jupyter/dockerspawner), you must specify the container image name and override the default container run command in your `jupyterhub_config.py`:

```python
# Spawn user containers from this image
c.DockerSpawner.container_image = 'jupyter/r-notebook'

# Have the Spawner override the Docker run command
c.DockerSpawner.extra_create_kwargs.update({
'command': '/usr/local/bin/start-singleuser.sh'
})
```

### start.sh

The `start.sh` script supports the same features as the default `start-notebook.sh` script (e.g., `GRANT_SUDO`), but allows you to specify an arbitrary command to execute. For example, to run the text-based `ipython` console in a container, do the following:

```
docker run -it --rm jupyter/r-notebook start.sh ipython
```

This script is particularly useful when you derive a new Dockerfile from this image and install additional Jupyter applications with subcommands like `jupyter console`, `jupyter kernelgateway`, and `jupyter lab`.

### Others

You can bypass the provided scripts and specify your an arbitrary start command. If you do, keep in mind that certain features documented above will not function (e.g., `GRANT_SUDO`).