mirror/notebook
2
0
Fork 0
mirror of https://github.com/jupyter/notebook.git synced 2025-01-18 11:55:46 +08:00
Code Issues Packages Projects Releases Wiki Activity
9e3e946a42
notebook/docs/source/config_overview.rst
Adam Chainz a947025308 Convert readthedocs links for their .org -> .io migration for hosted projects 
As per [their blog post of the 27th April](https://blog.readthedocs.com/securing-subdomains/) ‘Securing subdomains’:

> Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard.

Test Plan: Manually visited all the links I’ve modified.
2016-10-09 21:56:18 +01:00

3.3 KiB
Raw Blame History

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 <configure_common>
  • Notebook server <configure_nbserver>
  • Notebook front-end client <configure_nbclient>
  • Notebook extensions <configure_nbextensions>

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.

Notebook server

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

  • Configuring the Notebook server

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

    $ jupyter notebook --generate-config

:ref:`Command line arguments for configuration <config>` settings are
documented in the configuration file and the user documentation.

  • Running a Notebook server <working_remotely>

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

Notebook front-end client

  • How front-end configuration works <frontend_config>
    • Example: Changing the notebook's default indentation setting <frontend_config>
    • Example: Restoring the notebook's default indentation setting <frontend_config>
  • Persisting configuration settings <frontend_config>

Notebook extensions

Security in Jupyter notebooks: <notebook_security> 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.