notebook/docs/source/config_overview.rst
Afshin Taylor Darian c19323de9a
Use Jupyter Releaser (#6048)
* Use Jupyter Releaser

* Automated Changelog Entry for 6.4.0a0 on notebook-releaser

* Publish 6.4.0a0

SHA256 hashes:

dist/notebook-6.4.0a0-py3-none-any.whl: abbbbb02504cedb85c2d5eeac39ea11615360b9b0075126bf180d6011eac14a5

dist/notebook-6.4.0a0.tar.gz: 2984630a020a9396c61b2c3b98f43b1957dd0121b162a926b3d6136fafa7ca16

* Bump to 6.5.0.dev0

* Remove jupyter_packaging as a runtime requirement

* Automated Changelog Entry for 6.4.0a1 on notebook-releaser

* Publish 6.4.0a1

SHA256 hashes:

dist/notebook-6.4.0a1-py3-none-any.whl: 4b0ae5cb972b5b16b18b942810b85859185ef2081017dd495e5f57099ce06ef4

dist/notebook-6.4.0a1.tar.gz: c48e10d34afa35e304e3b7deca1882508195960f35c4661dec044bb8da344ae5

* Bump to 6.5.0.dev0

* Update notebook/_version.py

Co-authored-by: Kevin Bates <kbates4@gmail.com>

* Update pyproject.toml

Co-authored-by: Kevin Bates <kbates4@gmail.com>

Co-authored-by: GitHub Action <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Steven Silvester <steven.silvester@ieee.org>
Co-authored-by: Kevin Bates <kbates4@gmail.com>
2021-05-12 11:04:31 -05:00

3.0 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

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.