Configuring Jupyter applications¶

Common Jupyter configuration system The Jupyter applications have a common config system, and a common config directory. By default, this is ~/.jupyter.

Kernel configuration directories If kernels use config files, these will normally be organised in separate directories. For instance, the IPython kernel looks for files in the IPython directory instead of the default Jupyter directory ~/.jupyter.

Python config files¶

To create the blank config files, run:

jupyter {application} --generate-config

The generated file will be named jupyter_application_config.py.

In the jupyter_application_config.py file, you can configure class attributes like this:

c.NotebookApp.port = 8754

Be careful with spelling – incorrect names will simply be ignored, with no error.

To add to a collection which may have already been defined elsewhere, you can use methods like those found on lists, dicts and sets: append, extend, prepend() (like extend, but at the front), add, and update (which works both for dicts and sets):

c.TemplateExporter.template_path.append('./templates')

Command line arguments¶

Every configurable value can be set from the command line and passed as an argument, using this syntax:

jupyter notebook --NotebookApp.port=8754

Many frequently used options have short aliases and flags, such as --port 8754 or --no-browser.

To see these abbreviated options, pass help or help-all as follows:

jupyter {application} --help       # Just the short options
jupyter {application} --help-all   # Includes options without short names

Options specified at the command line, in either normal or short format, will override options set within a configuration file.