Configuration Overview

Beyond the default configuration settings, you can configure a rich array of options to suit your workflow. Here are areas that are commonly configured when using Jupyter Notebook:

• Jupyter’s common configuration system

• Jupyter Server

• Notebook extensions

Let’s look at highlights of each area.

Jupyter’s Common Configuration system

Jupyter applications, from the Notebook to JupyterHub to nbgrader, share a common configuration system. The process for creating a configuration file and editing settings is similar for all the Jupyter applications.

• Jupyter’s Common Configuration Approach

• Common Directories and File Locations

• Language kernels

• traitlets provide a low-level architecture for configuration.

Disabling Custom CSS

Custom CSS is loaded by default as was done with Jupyter Notebook 6. In the jupyter configuration directory, the /.jupyter/custom/custom.css file will be loaded unless the the application is initialized with the custom_css flag with the argument set to False as in --JupyterNotebookApp.custom_css=False.

Jupyter server

The Jupyter Server runs the language kernel and communicates with the front-end Notebook client (i.e. the familiar notebook interface).

• Configuring the Jupyter Server

  To create a jupyter_server_config.py file in the .jupyter directory, with all the defaults commented out, use the following command:

  $ jupyter server --generate-config
  

• Running a Jupyter Server

• Related: Configuring a language kernel to run in the Jupyter Server enables your server to run other languages, like R or Julia.

Warning

Jupyter Notebook 7 is now based on Jupyter Server. This may break some previous notebook imports you may have been using, such as notebook.auth or notebook.notebookapp.

Check out the migration guide to learn more on how to update these server imports.

Notebook extensions

The Notebook frontend can be extending with JupyterLab extensions.

See the Frontend Extension Guide for more information.

Security in Jupyter notebooks: Since security policies vary from organization to organization, we encourage you to consult with your security team on settings that would be best for your use cases. Our documentation offers some responsible security practices, and we recommend becoming familiar with the practices.