123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605 |
- # Configuration file for jupyter-notebook.
- #------------------------------------------------------------------------------
- # Application(SingletonConfigurable) configuration
- #------------------------------------------------------------------------------
- ## This is an application.
- ## The date format used by logging formatters for %(asctime)s
- #c.Application.log_datefmt = '%Y-%m-%d %H:%M:%S'
- ## The Logging format template
- #c.Application.log_format = '[%(name)s]%(highlevel)s %(message)s'
- ## Set the log level by value or name.
- #c.Application.log_level = 30
- #------------------------------------------------------------------------------
- # JupyterApp(Application) configuration
- #------------------------------------------------------------------------------
- ## Base class for Jupyter applications
- ## Answer yes to any prompts.
- #c.JupyterApp.answer_yes = False
- ## Full path of a config file.
- #c.JupyterApp.config_file = u''
- ## Specify a config file to load.
- #c.JupyterApp.config_file_name = u''
- ## Generate default config file.
- #c.JupyterApp.generate_config = False
- #------------------------------------------------------------------------------
- # NotebookApp(JupyterApp) configuration
- #------------------------------------------------------------------------------
- ## Set the Access-Control-Allow-Credentials: true header
- #c.NotebookApp.allow_credentials = False
- ## Set the Access-Control-Allow-Origin header
- #
- # Use '*' to allow any origin to access your server.
- #
- # Takes precedence over allow_origin_pat.
- #c.NotebookApp.allow_origin = ''
- ## Use a regular expression for the Access-Control-Allow-Origin header
- #
- # Requests from an origin matching the expression will get replies with:
- #
- # Access-Control-Allow-Origin: origin
- #
- # where `origin` is the origin of the request.
- #
- # Ignored if allow_origin is set.
- #c.NotebookApp.allow_origin_pat = ''
- ## Whether to allow the user to run the notebook as root.
- #c.NotebookApp.allow_root = False
- ## DEPRECATED use base_url
- #c.NotebookApp.base_project_url = '/'
- ## The base URL for the notebook server.
- #
- # Leading and trailing slashes can be omitted, and will automatically be added.
- #c.NotebookApp.base_url = '/'
- ## Specify what command to use to invoke a web browser when opening the notebook.
- # If not specified, the default browser will be determined by the `webbrowser`
- # standard library module, which allows setting of the BROWSER environment
- # variable to override it.
- #c.NotebookApp.browser = u''
- ## The full path to an SSL/TLS certificate file.
- #c.NotebookApp.certfile = u''
- ## The full path to a certificate authority certificate for SSL/TLS client
- # authentication.
- #c.NotebookApp.client_ca = u''
- ## The config manager class to use
- #c.NotebookApp.config_manager_class = 'notebook.services.config.manager.ConfigManager'
- ## The notebook manager class to use.
- #c.NotebookApp.contents_manager_class = 'notebook.services.contents.largefilemanager.LargeFileManager'
- ## Extra keyword arguments to pass to `set_secure_cookie`. See tornado's
- # set_secure_cookie docs for details.
- #c.NotebookApp.cookie_options = {}
- ## The random bytes used to secure cookies. By default this is a new random
- # number every time you start the Notebook. Set it to a value in a config file
- # to enable logins to persist across server sessions.
- #
- # Note: Cookie secrets should be kept private, do not share config files with
- # cookie_secret stored in plaintext (you can read the value from a file).
- #c.NotebookApp.cookie_secret = ''
- ## The file where the cookie secret is stored.
- #c.NotebookApp.cookie_secret_file = u''
- ## The default URL to redirect to from `/`
- #c.NotebookApp.default_url = '/tree'
- ## Disable cross-site-request-forgery protection
- #
- # Jupyter notebook 4.3.1 introduces protection from cross-site request
- # forgeries, requiring API requests to either:
- #
- # - originate from pages served by this server (validated with XSRF cookie and
- # token), or - authenticate with a token
- #
- # Some anonymous compute resources still desire the ability to run code,
- # completely without authentication. These services can disable all
- # authentication and security checks, with the full knowledge of what that
- # implies.
- #c.NotebookApp.disable_check_xsrf = False
- ## Whether to enable MathJax for typesetting math/TeX
- #
- # MathJax is the javascript library Jupyter uses to render math/LaTeX. It is
- # very large, so you may want to disable it if you have a slow internet
- # connection, or for offline use of the notebook.
- #
- # When disabled, equations etc. will appear as their untransformed TeX source.
- #c.NotebookApp.enable_mathjax = True
- ## extra paths to look for Javascript notebook extensions
- #c.NotebookApp.extra_nbextensions_path = []
- ## Extra paths to search for serving static files.
- #
- # This allows adding javascript/css to be available from the notebook server
- # machine, or overriding individual files in the IPython
- #c.NotebookApp.extra_static_paths = []
- ## Extra paths to search for serving jinja templates.
- #
- # Can be used to override templates from notebook.templates.
- #c.NotebookApp.extra_template_paths = []
- ##
- #c.NotebookApp.file_to_run = ''
- ## Deprecated: Use minified JS file or not, mainly use during dev to avoid JS
- # recompilation
- #c.NotebookApp.ignore_minified_js = False
- ## (bytes/sec) Maximum rate at which messages can be sent on iopub before they
- # are limited.
- #c.NotebookApp.iopub_data_rate_limit = 1000000
- ## (msgs/sec) Maximum rate at which messages can be sent on iopub before they are
- # limited.
- #c.NotebookApp.iopub_msg_rate_limit = 1000
- ## The IP address the notebook server will listen on.
- c.NotebookApp.ip = '*'
- ## Supply extra arguments that will be passed to Jinja environment.
- #c.NotebookApp.jinja_environment_options = {}
- ## Extra variables to supply to jinja templates when rendering.
- #c.NotebookApp.jinja_template_vars = {}
- ## The kernel manager class to use.
- #c.NotebookApp.kernel_manager_class = 'notebook.services.kernels.kernelmanager.MappingKernelManager'
- ## The kernel spec manager class to use. Should be a subclass of
- # `jupyter_client.kernelspec.KernelSpecManager`.
- #
- # The Api of KernelSpecManager is provisional and might change without warning
- # between this version of Jupyter and the next stable one.
- #c.NotebookApp.kernel_spec_manager_class = 'jupyter_client.kernelspec.KernelSpecManager'
- ## The full path to a private key file for usage with SSL/TLS.
- #c.NotebookApp.keyfile = u''
- ## The login handler class to use.
- #c.NotebookApp.login_handler_class = 'notebook.auth.login.LoginHandler'
- ## The logout handler class to use.
- #c.NotebookApp.logout_handler_class = 'notebook.auth.logout.LogoutHandler'
- ## The MathJax.js configuration file that is to be used.
- #c.NotebookApp.mathjax_config = 'TeX-AMS-MML_HTMLorMML-full,Safe'
- ## A custom url for MathJax.js. Should be in the form of a case-sensitive url to
- # MathJax, for example: /static/components/MathJax/MathJax.js
- #c.NotebookApp.mathjax_url = ''
- ## Dict of Python modules to load as notebook server extensions.Entry values can
- # be used to enable and disable the loading ofthe extensions. The extensions
- # will be loaded in alphabetical order.
- #c.NotebookApp.nbserver_extensions = {}
- ## The directory to use for notebooks and kernels.
- #c.NotebookApp.notebook_dir = u''
- ## Whether to open in a browser after starting. The specific browser used is
- # platform dependent and determined by the python standard library `webbrowser`
- # module, unless it is overridden using the --browser (NotebookApp.browser)
- # configuration option.
- c.NotebookApp.open_browser = False
- ## Hashed password to use for web authentication.
- #
- # To generate, type in a python/IPython shell:
- #
- # from notebook.auth import passwd; passwd()
- #
- # The string should be of the form type:salt:hashed-password.
- c.NotebookApp.password = u'sha1:541752f910ba:24d697c59553365469ca804b54127458aa35b755'
- ## Forces users to use a password for the Notebook server. This is useful in a
- # multi user environment, for instance when everybody in the LAN can access each
- # other's machine though ssh.
- #
- # In such a case, server the notebook server on localhost is not secure since
- # any user can connect to the notebook server via ssh.
- #c.NotebookApp.password_required = False
- ## The port the notebook server will listen on.
- c.NotebookApp.port = 8888
- ## The number of additional ports to try if the specified port is not available.
- #c.NotebookApp.port_retries = 50
- ## DISABLED: use %pylab or %matplotlib in the notebook to enable matplotlib.
- c.NotebookApp.pylab = 'inline'
- ## (sec) Time window used to check the message and data rate limits.
- #c.NotebookApp.rate_limit_window = 3
- ## Reraise exceptions encountered loading server extensions?
- #c.NotebookApp.reraise_server_extension_failures = False
- ## DEPRECATED use the nbserver_extensions dict instead
- #c.NotebookApp.server_extensions = []
- ## The session manager class to use.
- #c.NotebookApp.session_manager_class = 'notebook.services.sessions.sessionmanager.SessionManager'
- ## Supply SSL options for the tornado HTTPServer. See the tornado docs for
- # details.
- #c.NotebookApp.ssl_options = {}
- ## Supply overrides for terminado. Currently only supports "shell_command".
- #c.NotebookApp.terminado_settings = {}
- ## Token used for authenticating first-time connections to the server.
- #
- # When no password is enabled, the default is to generate a new, random token.
- #
- # Setting to an empty string disables authentication altogether, which is NOT
- # RECOMMENDED.
- #c.NotebookApp.token = '<generated>'
- ## Supply overrides for the tornado.web.Application that the Jupyter notebook
- # uses.
- #c.NotebookApp.tornado_settings = {}
- ## Whether to trust or not X-Scheme/X-Forwarded-Proto and X-Real-Ip/X-Forwarded-
- # For headerssent by the upstream reverse proxy. Necessary if the proxy handles
- # SSL
- #c.NotebookApp.trust_xheaders = False
- ## DEPRECATED, use tornado_settings
- #c.NotebookApp.webapp_settings = {}
- ## The base URL for websockets, if it differs from the HTTP server (hint: it
- # almost certainly doesn't).
- #
- # Should be in the form of an HTTP origin: ws[s]://hostname[:port]
- #c.NotebookApp.websocket_url = ''
- #------------------------------------------------------------------------------
- # ConnectionFileMixin(LoggingConfigurable) configuration
- #------------------------------------------------------------------------------
- ## Mixin for configurable classes that work with connection files
- ## JSON file in which to store connection info [default: kernel-<pid>.json]
- #
- # This file will contain the IP, ports, and authentication key needed to connect
- # clients to this kernel. By default, this file will be created in the security
- # dir of the current profile, but can be specified by absolute path.
- #c.ConnectionFileMixin.connection_file = ''
- ## set the control (ROUTER) port [default: random]
- #c.ConnectionFileMixin.control_port = 0
- ## set the heartbeat port [default: random]
- #c.ConnectionFileMixin.hb_port = 0
- ## set the iopub (PUB) port [default: random]
- #c.ConnectionFileMixin.iopub_port = 0
- ## Set the kernel's IP address [default localhost]. If the IP address is
- # something other than localhost, then Consoles on other machines will be able
- # to connect to the Kernel, so be careful!
- #c.ConnectionFileMixin.ip = u''
- ## set the shell (ROUTER) port [default: random]
- #c.ConnectionFileMixin.shell_port = 0
- ## set the stdin (ROUTER) port [default: random]
- #c.ConnectionFileMixin.stdin_port = 0
- ##
- #c.ConnectionFileMixin.transport = 'tcp'
- #------------------------------------------------------------------------------
- # KernelManager(ConnectionFileMixin) configuration
- #------------------------------------------------------------------------------
- ## Manages a single kernel in a subprocess on this host.
- #
- # This version starts kernels with Popen.
- ## Should we autorestart the kernel if it dies.
- #c.KernelManager.autorestart = True
- ## DEPRECATED: Use kernel_name instead.
- #
- # The Popen Command to launch the kernel. Override this if you have a custom
- # kernel. If kernel_cmd is specified in a configuration file, Jupyter does not
- # pass any arguments to the kernel, because it cannot make any assumptions about
- # the arguments that the kernel understands. In particular, this means that the
- # kernel does not receive the option --debug if it given on the Jupyter command
- # line.
- #c.KernelManager.kernel_cmd = []
- ## Time to wait for a kernel to terminate before killing it, in seconds.
- #c.KernelManager.shutdown_wait_time = 5.0
- #------------------------------------------------------------------------------
- # Session(Configurable) configuration
- #------------------------------------------------------------------------------
- ## Object for handling serialization and sending of messages.
- #
- # The Session object handles building messages and sending them with ZMQ sockets
- # or ZMQStream objects. Objects can communicate with each other over the
- # network via Session objects, and only need to work with the dict-based IPython
- # message spec. The Session will handle serialization/deserialization, security,
- # and metadata.
- #
- # Sessions support configurable serialization via packer/unpacker traits, and
- # signing with HMAC digests via the key/keyfile traits.
- #
- # Parameters ----------
- #
- # debug : bool
- # whether to trigger extra debugging statements
- # packer/unpacker : str : 'json', 'pickle' or import_string
- # importstrings for methods to serialize message parts. If just
- # 'json' or 'pickle', predefined JSON and pickle packers will be used.
- # Otherwise, the entire importstring must be used.
- #
- # The functions must accept at least valid JSON input, and output *bytes*.
- #
- # For example, to use msgpack:
- # packer = 'msgpack.packb', unpacker='msgpack.unpackb'
- # pack/unpack : callables
- # You can also set the pack/unpack callables for serialization directly.
- # session : bytes
- # the ID of this Session object. The default is to generate a new UUID.
- # username : unicode
- # username added to message headers. The default is to ask the OS.
- # key : bytes
- # The key used to initialize an HMAC signature. If unset, messages
- # will not be signed or checked.
- # keyfile : filepath
- # The file containing a key. If this is set, `key` will be initialized
- # to the contents of the file.
- ## Threshold (in bytes) beyond which an object's buffer should be extracted to
- # avoid pickling.
- #c.Session.buffer_threshold = 1024
- ## Whether to check PID to protect against calls after fork.
- #
- # This check can be disabled if fork-safety is handled elsewhere.
- #c.Session.check_pid = True
- ## Threshold (in bytes) beyond which a buffer should be sent without copying.
- #c.Session.copy_threshold = 65536
- ## Debug output in the Session
- #c.Session.debug = False
- ## The maximum number of digests to remember.
- #
- # The digest history will be culled when it exceeds this value.
- #c.Session.digest_history_size = 65536
- ## The maximum number of items for a container to be introspected for custom
- # serialization. Containers larger than this are pickled outright.
- #c.Session.item_threshold = 64
- ## execution key, for signing messages.
- #c.Session.key = ''
- ## path to file containing execution key.
- #c.Session.keyfile = ''
- ## Metadata dictionary, which serves as the default top-level metadata dict for
- # each message.
- #c.Session.metadata = {}
- ## The name of the packer for serializing messages. Should be one of 'json',
- # 'pickle', or an import name for a custom callable serializer.
- #c.Session.packer = 'json'
- ## The UUID identifying this session.
- #c.Session.session = u''
- ## The digest scheme used to construct the message signatures. Must have the form
- # 'hmac-HASH'.
- #c.Session.signature_scheme = 'hmac-sha256'
- ## The name of the unpacker for unserializing messages. Only used with custom
- # functions for `packer`.
- #c.Session.unpacker = 'json'
- ## Username for the Session. Default is your system username.
- #c.Session.username = u'username'
- #------------------------------------------------------------------------------
- # MultiKernelManager(LoggingConfigurable) configuration
- #------------------------------------------------------------------------------
- ## A class for managing multiple kernels.
- ## The name of the default kernel to start
- #c.MultiKernelManager.default_kernel_name = 'python2'
- ## The kernel manager class. This is configurable to allow subclassing of the
- # KernelManager for customized behavior.
- #c.MultiKernelManager.kernel_manager_class = 'jupyter_client.ioloop.IOLoopKernelManager'
- #------------------------------------------------------------------------------
- # MappingKernelManager(MultiKernelManager) configuration
- #------------------------------------------------------------------------------
- ## A KernelManager that handles notebook mapping and HTTP error handling
- ##
- #c.MappingKernelManager.root_dir = u''
- #------------------------------------------------------------------------------
- # ContentsManager(LoggingConfigurable) configuration
- #------------------------------------------------------------------------------
- ## Base class for serving files and directories.
- #
- # This serves any text or binary file, as well as directories, with special
- # handling for JSON notebook documents.
- #
- # Most APIs take a path argument, which is always an API-style unicode path, and
- # always refers to a directory.
- #
- # - unicode, not url-escaped
- # - '/'-separated
- # - leading and trailing '/' will be stripped
- # - if unspecified, path defaults to '',
- # indicating the root path.
- ##
- #c.ContentsManager.checkpoints = None
- ##
- #c.ContentsManager.checkpoints_class = 'notebook.services.contents.checkpoints.Checkpoints'
- ##
- #c.ContentsManager.checkpoints_kwargs = {}
- ## Glob patterns to hide in file and directory listings.
- #c.ContentsManager.hide_globs = [u'__pycache__', '*.pyc', '*.pyo', '.DS_Store', '*.so', '*.dylib', '*~']
- ## Python callable or importstring thereof
- #
- # To be called on a contents model prior to save.
- #
- # This can be used to process the structure, such as removing notebook outputs
- # or other side effects that should not be saved.
- #
- # It will be called as (all arguments passed by keyword)::
- #
- # hook(path=path, model=model, contents_manager=self)
- #
- # - model: the model to be saved. Includes file contents.
- # Modifying this dict will affect the file that is stored.
- # - path: the API path of the save destination
- # - contents_manager: this ContentsManager instance
- #c.ContentsManager.pre_save_hook = None
- ##
- #c.ContentsManager.root_dir = '/'
- ## The base name used when creating untitled directories.
- #c.ContentsManager.untitled_directory = 'Untitled Folder'
- ## The base name used when creating untitled files.
- #c.ContentsManager.untitled_file = 'untitled'
- ## The base name used when creating untitled notebooks.
- #c.ContentsManager.untitled_notebook = 'Untitled'
- #------------------------------------------------------------------------------
- # FileManagerMixin(Configurable) configuration
- #------------------------------------------------------------------------------
- ## Mixin for ContentsAPI classes that interact with the filesystem.
- #
- # Provides facilities for reading, writing, and copying both notebooks and
- # generic files.
- #
- # Shared by FileContentsManager and FileCheckpoints.
- #
- # Note ---- Classes using this mixin must provide the following attributes:
- #
- # root_dir : unicode
- # A directory against against which API-style paths are to be resolved.
- #
- # log : logging.Logger
- ## By default notebooks are saved on disk on a temporary file and then if
- # succefully written, it replaces the old ones. This procedure, namely
- # 'atomic_writing', causes some bugs on file system whitout operation order
- # enforcement (like some networked fs). If set to False, the new notebook is
- # written directly on the old one which could fail (eg: full filesystem or quota
- # )
- #c.FileManagerMixin.use_atomic_writing = True
- #------------------------------------------------------------------------------
- # FileContentsManager(FileManagerMixin,ContentsManager) configuration
- #------------------------------------------------------------------------------
- ## Python callable or importstring thereof
- #
- # to be called on the path of a file just saved.
- #
- # This can be used to process the file on disk, such as converting the notebook
- # to a script or HTML via nbconvert.
- #
- # It will be called as (all arguments passed by keyword)::
- #
- # hook(os_path=os_path, model=model, contents_manager=instance)
- #
- # - path: the filesystem path to the file just written - model: the model
- # representing the file - contents_manager: this ContentsManager instance
- #c.FileContentsManager.post_save_hook = None
- ##
- #c.FileContentsManager.root_dir = u''
- ## DEPRECATED, use post_save_hook. Will be removed in Notebook 5.0
- #c.FileContentsManager.save_script = False
- #------------------------------------------------------------------------------
- # NotebookNotary(LoggingConfigurable) configuration
- #------------------------------------------------------------------------------
- ## A class for computing and verifying notebook signatures.
- ## The hashing algorithm used to sign notebooks.
- #c.NotebookNotary.algorithm = 'sha256'
- ## The sqlite file in which to store notebook signatures. By default, this will
- # be in your Jupyter data directory. You can set it to ':memory:' to disable
- # sqlite writing to the filesystem.
- #c.NotebookNotary.db_file = u''
- ## The secret key with which notebooks are signed.
- #c.NotebookNotary.secret = ''
- ## The file where the secret key is stored.
- #c.NotebookNotary.secret_file = u''
- ## A callable returning the storage backend for notebook signatures. The default
- # uses an SQLite database.
- #c.NotebookNotary.store_factory = traitlets.Undefined
- #------------------------------------------------------------------------------
- # KernelSpecManager(LoggingConfigurable) configuration
- #------------------------------------------------------------------------------
- ## If there is no Python kernelspec registered and the IPython kernel is
- # available, ensure it is added to the spec list.
- #c.KernelSpecManager.ensure_native_kernel = True
- ## The kernel spec class. This is configurable to allow subclassing of the
- # KernelSpecManager for customized behavior.
- #c.KernelSpecManager.kernel_spec_class = 'jupyter_client.kernelspec.KernelSpec'
- ## Whitelist of allowed kernel names.
- #
- # By default, all installed kernels are allowed.
- #c.KernelSpecManager.whitelist = set([])
|