Vagrant provisioning for Geonotebook

January 31, 2017 ยท View on GitHub

Running

From the root of the directory, running vagrant up will result in a running virtual machine with a message like this one:

Geonotebook is running at http://localhost:8888

Configurable Options

Through the use of Ansible extra_vars, any of the variables documented in the Geonotebook role docs can be manipulated.

Environment Variables

variablecomments
VAGRANT_MEMORYThe number (in MB) of RAM to use on the virtual machine (defaults to 2048).
VAGRANT_CPUSThe number of CPUs to use on the virtual machine (defaults to 2).
GEONOTEBOOK_DIRDocumentation for this can be found in the Geonotebook role docs.
GEONOTEBOOK_VERSIONDocumentation for this can be found in the Geonotebook role docs.
GEONOTEBOOK_UPDATEDocumentation for this can be found in the Geonotebook role docs.
GEONOTEBOOK_FORCEDocumentation for this can be found in the Geonotebook role docs.
GEONOTEBOOK_AUTH_ENABLEDDocumentation for this can be found in the Geonotebook role docs.
GEONOTEBOOK_AUTH_TOKENDocumentation for this can be found in the Geonotebook role docs.

Jupyter Auth

By default, Jupyter authentication is disabled in the Vagrant environment as it's meant to be a development environment. Jupyter authentication should always be enabled on production systems.

If Jupyter authentication is desired, the environment variables related to GEONOTEBOOK_AUTH_* must be set, note the auth token must be set to the same token each time the machine is provisioned.