Official Docker Images

Polynote publishes official Docker images upon every release. Most users are recommended to use the latest tag by running docker pull polynote/polynote:latest.

Published Tags

Every release of Polynote will publish four images:

Additionally, the latest tag is updated to point to polynote/polynote:${POLYNOTE_VERSION}-2.11-spark2.4.

Usage Instructions

Here are some simple instructions for running Polynote from a Docker image. Please note that these instructions are meant for use in a safe, development environment and should not be used in production.

Keep in mind that Polynote, like all notebook tools, allows arbitrary remote code execution. Running it in a Docker container, while mitigating certain possible attack vectors, does not automatically make it safe.

For this reason, the Docker images we publish do NOT come with any changes to the default configuration.

Here are some instructions for a simple setup enabling users try out the latest Polynote image.

First, we'll do some setup and create a local directory in which to put our configuration and save our notebooks.

mkdir ~/polynote-docker
cd ~/polynote-docker

Next, make a config.yml file with the following contents:

listen:
  host: 0.0.0.0

storage:
  dir: /opt/notebooks
  mounts:
    examples:
      dir: examples

The listen directive tells Polynote to listen on all interfaces inside the Docker container. While this is probably fine for trying it out, it's not fit for production settings.

The storage directive specifies /opt/notebooks as the primary notebook location. This is the location that is visible in the file-explorer on the left in Polynote. The Polynote installation comes with some example files, which we mount into /opt/notebooks, allowing you to see the examples and try them out without having to make copies. Note that changes to the examples will not be persisted onto the host if you follow the instructions given. Only files outside the examples folder visible in the sidebar will persist (in your local notebooks folder).

We are now ready to run the Docker container! Use the following command:

docker run --rm -it -p 127.0.0.1:8192:8192 -p 127.0.0.1:4040-4050:4040-4050 -v `pwd`/config.yml:/opt/config/config.yml -v `pwd`/notebooks:/opt/notebooks/ polynote/polynote:latest --config /opt/config/config.yml

Let's go over what this command does.

• -p 127.0.0.1:8192:8192 This binds 127.0.0.1:8192 on the host machine to port 8192 inside the container.
• -p 127.0.0.1:4040-4050:4040-4050 This binds a range of ports on the host machine so you can see the Spark UI.
• -v `pwd`/config.yml:/opt/config/config.yml This mounts the config file in the current directory (the one you just created) into the container at /opt/config/config.yml
• -v `pwd`/notebooks:/opt/notebooks This mounts the ./notebooks directory on the host into the container at /opt/notebooks/, so that any notebooks you create are saved back to the host, and the example notebooks inside of examples/ are still visible to you.
• polynote/polynote:latest pulls the latest Polynote image
• --config /opt/config/config.yml tells Polynote to use the config.yml file you created earlier.

Great! Now just open up Chrome and navigate over to http://localhost:8192/ and you'll see the Polynote UI! You'll see the example folder show up on the left. Open it up and run some of the examples! 😄

Note: Changes you make to the example notebooks won't persist, since they aren't mounted to the host.

Try making a new notebook by clicking the new notebook button and typing "my first notebook" into the dialog box. You should see it show up in the notebooks tree!

Now, if you open up a new terminal window and run ls -l ~/polynote-docker/notebooks, you should see my first notebook.ipynb on your host machine!

Note: the Docker image will be run as a non-root user named polly, which has no password enabled for extra security.

Building the Image

To build the image from the Dockerfiles included here, run the following series of commands from the docker directory:

We tag these images with the name polynote-local.

Base image

Change version to match desired target

export POLYNOTE_VERSION=0.2.13
docker build -t polynote-local:latest --build-arg POLYNOTE_VERSION=$POLYNOTE_VERSION base

Dev image

First we run sbt dist from the root of this repository to create target/scala-2.11/ and the .tar file inside. We then go to this new directory and build from within there:

sbt dist
cd target/scala-2.11/
docker build -t polynote-local:dev -f ../../docker/dev/Dockerfile .

Spark v2.4 image

Change version to match desired target

export POLYNOTE_VERSION=0.2.13
docker build -t polynote-local:spark24 --build-arg POLYNOTE_VERSION=$POLYNOTE_VERSION spark-2.4