fXM1k1Je

1# Configuration file for jupyter-notebook.
2
3#------------------------------------------------------------------------------
4# Application(SingletonConfigurable) configuration
5#------------------------------------------------------------------------------
6
7## This is an application.
8
9## The date format used by logging formatters for %(asctime)s
10#c.Application.log_datefmt = '%Y-%m-%d %H:%M:%S'
11
12## The Logging format template
13#c.Application.log_format = '[%(name)s]%(highlevel)s %(message)s'
14
15## Set the log level by value or name.
16#c.Application.log_level = 30
17
18#------------------------------------------------------------------------------
19# JupyterApp(Application) configuration
20#------------------------------------------------------------------------------
21
22## Base class for Jupyter applications
23
24## Answer yes to any prompts.
25#c.JupyterApp.answer_yes = False
26
27## Full path of a config file.
28#c.JupyterApp.config_file = ''
29
30## Specify a config file to load.
31#c.JupyterApp.config_file_name = ''
32
33## Generate default config file.
34#c.JupyterApp.generate_config = False
35
36#------------------------------------------------------------------------------
37# NotebookApp(JupyterApp) configuration
38#------------------------------------------------------------------------------
39
40## Set the Access-Control-Allow-Credentials: true header
41#c.NotebookApp.allow_credentials = False
42
43## Set the Access-Control-Allow-Origin header
44#
45#  Use '*' to allow any origin to access your server.
46#
47#  Takes precedence over allow_origin_pat.
48#c.NotebookApp.allow_origin = ''
49
50## Use a regular expression for the Access-Control-Allow-Origin header
51#
52#  Requests from an origin matching the expression will get replies with:
53#
54#      Access-Control-Allow-Origin: origin
55#
56#  where `origin` is the origin of the request.
57#
58#  Ignored if allow_origin is set.
59#c.NotebookApp.allow_origin_pat = ''
60
61## Allow password to be changed at login for the notebook server.
62#
63#  While loggin in with a token, the notebook server UI will give the opportunity
64#  to the user to enter a new password at the same time that will replace the
65#  token login mechanism.
66#
67#  This can be set to false to prevent changing password from the UI/API.
68#c.NotebookApp.allow_password_change = True
69
70## Allow requests where the Host header doesn't point to a local server
71#
72#  By default, requests get a 403 forbidden response if the 'Host' header shows
73#  that the browser thinks it's on a non-local domain. Setting this option to
74#  True disables this check.
75#
76#  This protects against 'DNS rebinding' attacks, where a remote web server
77#  serves you a page and then changes its DNS to send later requests to a local
78#  IP, bypassing same-origin checks.
79#
80#  Local IP addresses (such as 127.0.0.1 and ::1) are allowed as local, along
81#  with hostnames configured in local_hostnames.
82#c.NotebookApp.allow_remote_access = False
83
84## Whether to allow the user to run the notebook as root.
85#c.NotebookApp.allow_root = False
86
87## DEPRECATED use base_url
88#c.NotebookApp.base_project_url = '/'
89
90## The base URL for the notebook server.
91#
92#  Leading and trailing slashes can be omitted, and will automatically be added.
93#c.NotebookApp.base_url = '/'
94
95## Specify what command to use to invoke a web browser when opening the notebook.
96#  If not specified, the default browser will be determined by the `webbrowser`
97#  standard library module, which allows setting of the BROWSER environment
98#  variable to override it.
99c.NotebookApp.browser = 'start chrome'
100
101## The full path to an SSL/TLS certificate file.
102#c.NotebookApp.certfile = ''
103
104## The full path to a certificate authority certificate for SSL/TLS client
105#  authentication.
106#c.NotebookApp.client_ca = ''
107
108## The config manager class to use
109#c.NotebookApp.config_manager_class = 'notebook.services.config.manager.ConfigManager'
110
111## The notebook manager class to use.
112#c.NotebookApp.contents_manager_class = 'notebook.services.contents.largefilemanager.LargeFileManager'
113
114## Extra keyword arguments to pass to `set_secure_cookie`. See tornado's
115#  set_secure_cookie docs for details.
116#c.NotebookApp.cookie_options = {}
117
118## The random bytes used to secure cookies. By default this is a new random
119#  number every time you start the Notebook. Set it to a value in a config file
120#  to enable logins to persist across server sessions.
121#
122#  Note: Cookie secrets should be kept private, do not share config files with
123#  cookie_secret stored in plaintext (you can read the value from a file).
124#c.NotebookApp.cookie_secret = b''
125
126## The file where the cookie secret is stored.
127#c.NotebookApp.cookie_secret_file = ''
128
129## Override URL shown to users.
130#
131#  Replace actual URL, including protocol, address, port and base URL, with the
132#  given value when displaying URL to the users. Do not change the actual
133#  connection URL. If authentication token is enabled, the token is added to the
134#  custom URL automatically.
135#
136#  This option is intended to be used when the URL to display to the user cannot
137#  be determined reliably by the Jupyter notebook server (proxified or
138#  containerized setups for example).
139#c.NotebookApp.custom_display_url = ''
140
141## The default URL to redirect to from `/`
142#c.NotebookApp.default_url = '/tree'
143
144## Disable cross-site-request-forgery protection
145#
146#  Jupyter notebook 4.3.1 introduces protection from cross-site request
147#  forgeries, requiring API requests to either:
148#
149#  - originate from pages served by this server (validated with XSRF cookie and
150#  token), or - authenticate with a token
151#
152#  Some anonymous compute resources still desire the ability to run code,
153#  completely without authentication. These services can disable all
154#  authentication and security checks, with the full knowledge of what that
155#  implies.
156#c.NotebookApp.disable_check_xsrf = False
157
158## Whether to enable MathJax for typesetting math/TeX
159#
160#  MathJax is the javascript library Jupyter uses to render math/LaTeX. It is
161#  very large, so you may want to disable it if you have a slow internet
162#  connection, or for offline use of the notebook.
163#
164#  When disabled, equations etc. will appear as their untransformed TeX source.
165#c.NotebookApp.enable_mathjax = True
166
167## extra paths to look for Javascript notebook extensions
168#c.NotebookApp.extra_nbextensions_path = []
169
170## handlers that should be loaded at higher priority than the default services
171#c.NotebookApp.extra_services = []
172
173## Extra paths to search for serving static files.
174#
175#  This allows adding javascript/css to be available from the notebook server
176#  machine, or overriding individual files in the IPython
177#c.NotebookApp.extra_static_paths = []
178
179## Extra paths to search for serving jinja templates.
180#
181#  Can be used to override templates from notebook.templates.
182#c.NotebookApp.extra_template_paths = []
183
184##
185#c.NotebookApp.file_to_run = ''
186
187## Extra keyword arguments to pass to `get_secure_cookie`. See tornado's
188#  get_secure_cookie docs for details.
189#c.NotebookApp.get_secure_cookie_kwargs = {}
190
191## Deprecated: Use minified JS file or not, mainly use during dev to avoid JS
192#  recompilation
193#c.NotebookApp.ignore_minified_js = False
194
195## (bytes/sec) Maximum rate at which stream output can be sent on iopub before
196#  they are limited.
197#c.NotebookApp.iopub_data_rate_limit = 1000000
198
199## (msgs/sec) Maximum rate at which messages can be sent on iopub before they are
200#  limited.
201#c.NotebookApp.iopub_msg_rate_limit = 1000
202
203## The IP address the notebook server will listen on.
204#c.NotebookApp.ip = 'localhost'
205
206## Supply extra arguments that will be passed to Jinja environment.
207#c.NotebookApp.jinja_environment_options = {}
208
209## Extra variables to supply to jinja templates when rendering.
210#c.NotebookApp.jinja_template_vars = {}
211
212## The kernel manager class to use.
213#c.NotebookApp.kernel_manager_class = 'notebook.services.kernels.kernelmanager.MappingKernelManager'
214
215## The kernel spec manager class to use. Should be a subclass of
216#  `jupyter_client.kernelspec.KernelSpecManager`.
217#
218#  The Api of KernelSpecManager is provisional and might change without warning
219#  between this version of Jupyter and the next stable one.
220#c.NotebookApp.kernel_spec_manager_class = 'jupyter_client.kernelspec.KernelSpecManager'
221
222## The full path to a private key file for usage with SSL/TLS.
223#c.NotebookApp.keyfile = ''
224
225## Hostnames to allow as local when allow_remote_access is False.
226#
227#  Local IP addresses (such as 127.0.0.1 and ::1) are automatically accepted as
228#  local as well.
229#c.NotebookApp.local_hostnames = ['localhost']
230
231## The login handler class to use.
232#c.NotebookApp.login_handler_class = 'notebook.auth.login.LoginHandler'
233
234## The logout handler class to use.
235#c.NotebookApp.logout_handler_class = 'notebook.auth.logout.LogoutHandler'
236
237## The MathJax.js configuration file that is to be used.
238#c.NotebookApp.mathjax_config = 'TeX-AMS-MML_HTMLorMML-full,Safe'
239
240## A custom url for MathJax.js. Should be in the form of a case-sensitive url to
241#  MathJax, for example:  /static/components/MathJax/MathJax.js
242#c.NotebookApp.mathjax_url = ''
243
244## Sets the maximum allowed size of the client request body, specified in  the
245#  Content-Length request header field. If the size in a request  exceeds the
246#  configured value, a malformed HTTP message is returned to the client.
247#
248#  Note: max_body_size is applied even in streaming mode.
249#c.NotebookApp.max_body_size = 536870912
250
251## Gets or sets the maximum amount of memory, in bytes, that is allocated  for
252#  use by the buffer manager.
253#c.NotebookApp.max_buffer_size = 536870912
254
255## Gets or sets a lower bound on the open file handles process resource limit.
256#  This may need to be increased if you run into an OSError: [Errno 24] Too many
257#  open files. This is not applicable when running on Windows.
258#c.NotebookApp.min_open_files_limit = 0
259
260## Dict of Python modules to load as notebook server extensions.Entry values can
261#  be used to enable and disable the loading ofthe extensions. The extensions
262#  will be loaded in alphabetical order.
263#c.NotebookApp.nbserver_extensions = {}
264
265## The directory to use for notebooks and kernels.
266#c.NotebookApp.notebook_dir = ''
267
268## Whether to open in a browser after starting. The specific browser used is
269#  platform dependent and determined by the python standard library `webbrowser`
270#  module, unless it is overridden using the --browser (NotebookApp.browser)
271#  configuration option.
272#c.NotebookApp.open_browser = True
273
274## Hashed password to use for web authentication.
275#
276#  To generate, type in a python/IPython shell:
277#
278#    from notebook.auth import passwd; passwd()
279#
280#  The string should be of the form type:salt:hashed-password.
281#c.NotebookApp.password = ''
282
283## Forces users to use a password for the Notebook server. This is useful in a
284#  multi user environment, for instance when everybody in the LAN can access each
285#  other's machine through ssh.
286#
287#  In such a case, server the notebook server on localhost is not secure since
288#  any user can connect to the notebook server via ssh.
289#c.NotebookApp.password_required = False
290
291## The port the notebook server will listen on.
292#c.NotebookApp.port = 8888
293
294## The number of additional ports to try if the specified port is not available.
295#c.NotebookApp.port_retries = 50
296
297## DISABLED: use %pylab or %matplotlib in the notebook to enable matplotlib.
298#c.NotebookApp.pylab = 'disabled'
299
300## If True, display a button in the dashboard to quit (shutdown the notebook
301#  server).
302#c.NotebookApp.quit_button = True
303
304## (sec) Time window used to  check the message and data rate limits.
305#c.NotebookApp.rate_limit_window = 3
306
307## Reraise exceptions encountered loading server extensions?
308#c.NotebookApp.reraise_server_extension_failures = False
309
310## DEPRECATED use the nbserver_extensions dict instead
311#c.NotebookApp.server_extensions = []
312
313## The session manager class to use.
314#c.NotebookApp.session_manager_class = 'notebook.services.sessions.sessionmanager.SessionManager'
315
316## Shut down the server after N seconds with no kernels or terminals running and
317#  no activity. This can be used together with culling idle kernels
318#  (MappingKernelManager.cull_idle_timeout) to shutdown the notebook server when
319#  it's not in use. This is not precisely timed: it may shut down up to a minute
320#  later. 0 (the default) disables this automatic shutdown.
321#c.NotebookApp.shutdown_no_activity_timeout = 0
322
323## Supply SSL options for the tornado HTTPServer. See the tornado docs for
324#  details.
325#c.NotebookApp.ssl_options = {}
326
327## Supply overrides for terminado. Currently only supports "shell_command".
328#c.NotebookApp.terminado_settings = {}
329
330## Set to False to disable terminals.
331#
332#  This does *not* make the notebook server more secure by itself. Anything the
333#  user can in a terminal, they can also do in a notebook.
334#
335#  Terminals may also be automatically disabled if the terminado package is not
336#  available.
337#c.NotebookApp.terminals_enabled = True
338
339## Token used for authenticating first-time connections to the server.
340#
341#  When no password is enabled, the default is to generate a new, random token.
342#
343#  Setting to an empty string disables authentication altogether, which is NOT
344#  RECOMMENDED.
345#c.NotebookApp.token = '<generated>'
346
347## Supply overrides for the tornado.web.Application that the Jupyter notebook
348#  uses.
349#c.NotebookApp.tornado_settings = {}
350
351## Whether to trust or not X-Scheme/X-Forwarded-Proto and X-Real-Ip/X-Forwarded-
352#  For headerssent by the upstream reverse proxy. Necessary if the proxy handles
353#  SSL
354#c.NotebookApp.trust_xheaders = False
355
356## Disable launching browser by redirect file
357#
358#  For versions of notebook > 5.7.2, a security feature measure was added that
359#  prevented the authentication token used to launch the browser from being
360#  visible. This feature makes it difficult for other users on a multi-user
361#  system from running code in your Jupyter session as you.
362#
363#  However, some environments (like Windows Subsystem for Linux (WSL) and
364#  Chromebooks), launching a browser using a redirect file can lead the browser
365#  failing to load.  This is because of the difference in file structures/paths
366#  between the runtime and  the browser.
367#
368#  Disabling this setting to False will disable this behavior, allowing the
369#  browser  to launch by using a URL and visible token (as before).
370#c.NotebookApp.use_redirect_file = True
371
372## DEPRECATED, use tornado_settings
373#c.NotebookApp.webapp_settings = {}
374
375## Specify Where to open the notebook on startup. This is the `new` argument
376#  passed to the standard library method `webbrowser.open`. The behaviour is not
377#  guaranteed, but depends on browser support. Valid values are:
378#
379#   - 2 opens a new tab,
380#   - 1 opens a new window,
381#   - 0 opens in an existing window.
382#
383#  See the `webbrowser.open` documentation for details.
384#c.NotebookApp.webbrowser_open_new = 2
385
386## Set the tornado compression options for websocket connections.
387#
388#  This value will be returned from
389#  :meth:`WebSocketHandler.get_compression_options`. None (default) will disable
390#  compression. A dict (even an empty one) will enable compression.
391#
392#  See the tornado docs for WebSocketHandler.get_compression_options for details.
393#c.NotebookApp.websocket_compression_options = None
394
395## The base URL for websockets, if it differs from the HTTP server (hint: it
396#  almost certainly doesn't).
397#
398#  Should be in the form of an HTTP origin: ws[s]://hostname[:port]
399#c.NotebookApp.websocket_url = ''
400
401#------------------------------------------------------------------------------
402# ConnectionFileMixin(LoggingConfigurable) configuration
403#------------------------------------------------------------------------------
404
405## Mixin for configurable classes that work with connection files
406
407## JSON file in which to store connection info [default: kernel-<pid>.json]
408#
409#  This file will contain the IP, ports, and authentication key needed to connect
410#  clients to this kernel. By default, this file will be created in the security
411#  dir of the current profile, but can be specified by absolute path.
412#c.ConnectionFileMixin.connection_file = ''
413
414## set the control (ROUTER) port [default: random]
415#c.ConnectionFileMixin.control_port = 0
416
417## set the heartbeat port [default: random]
418#c.ConnectionFileMixin.hb_port = 0
419
420## set the iopub (PUB) port [default: random]
421#c.ConnectionFileMixin.iopub_port = 0
422
423## Set the kernel's IP address [default localhost]. If the IP address is
424#  something other than localhost, then Consoles on other machines will be able
425#  to connect to the Kernel, so be careful!
426#c.ConnectionFileMixin.ip = ''
427
428## set the shell (ROUTER) port [default: random]
429#c.ConnectionFileMixin.shell_port = 0
430
431## set the stdin (ROUTER) port [default: random]
432#c.ConnectionFileMixin.stdin_port = 0
433
434##
435#c.ConnectionFileMixin.transport = 'tcp'
436
437#------------------------------------------------------------------------------
438# KernelManager(ConnectionFileMixin) configuration
439#------------------------------------------------------------------------------
440
441## Manages a single kernel in a subprocess on this host.
442#
443#  This version starts kernels with Popen.
444
445## Should we autorestart the kernel if it dies.
446#c.KernelManager.autorestart = True
447
448## DEPRECATED: Use kernel_name instead.
449#
450#  The Popen Command to launch the kernel. Override this if you have a custom
451#  kernel. If kernel_cmd is specified in a configuration file, Jupyter does not
452#  pass any arguments to the kernel, because it cannot make any assumptions about
453#  the arguments that the kernel understands. In particular, this means that the
454#  kernel does not receive the option --debug if it given on the Jupyter command
455#  line.
456#c.KernelManager.kernel_cmd = []
457
458## Time to wait for a kernel to terminate before killing it, in seconds.
459#c.KernelManager.shutdown_wait_time = 5.0
460
461#------------------------------------------------------------------------------
462# Session(Configurable) configuration
463#------------------------------------------------------------------------------
464
465## Object for handling serialization and sending of messages.
466#
467#  The Session object handles building messages and sending them with ZMQ sockets
468#  or ZMQStream objects.  Objects can communicate with each other over the
469#  network via Session objects, and only need to work with the dict-based IPython
470#  message spec. The Session will handle serialization/deserialization, security,
471#  and metadata.
472#
473#  Sessions support configurable serialization via packer/unpacker traits, and
474#  signing with HMAC digests via the key/keyfile traits.
475#
476#  Parameters ----------
477#
478#  debug : bool
479#      whether to trigger extra debugging statements
480#  packer/unpacker : str : 'json', 'pickle' or import_string
481#      importstrings for methods to serialize message parts.  If just
482#      'json' or 'pickle', predefined JSON and pickle packers will be used.
483#      Otherwise, the entire importstring must be used.
484#
485#      The functions must accept at least valid JSON input, and output *bytes*.
486#
487#      For example, to use msgpack:
488#      packer = 'msgpack.packb', unpacker='msgpack.unpackb'
489#  pack/unpack : callables
490#      You can also set the pack/unpack callables for serialization directly.
491#  session : bytes
492#      the ID of this Session object.  The default is to generate a new UUID.
493#  username : unicode
494#      username added to message headers.  The default is to ask the OS.
495#  key : bytes
496#      The key used to initialize an HMAC signature.  If unset, messages
497#      will not be signed or checked.
498#  keyfile : filepath
499#      The file containing a key.  If this is set, `key` will be initialized
500#      to the contents of the file.
501
502## Threshold (in bytes) beyond which an object's buffer should be extracted to
503#  avoid pickling.
504#c.Session.buffer_threshold = 1024
505
506## Whether to check PID to protect against calls after fork.
507#
508#  This check can be disabled if fork-safety is handled elsewhere.
509#c.Session.check_pid = True
510
511## Threshold (in bytes) beyond which a buffer should be sent without copying.
512#c.Session.copy_threshold = 65536
513
514## Debug output in the Session
515#c.Session.debug = False
516
517## The maximum number of digests to remember.
518#
519#  The digest history will be culled when it exceeds this value.
520#c.Session.digest_history_size = 65536
521
522## The maximum number of items for a container to be introspected for custom
523#  serialization. Containers larger than this are pickled outright.
524#c.Session.item_threshold = 64
525
526## execution key, for signing messages.
527#c.Session.key = b''
528
529## path to file containing execution key.
530#c.Session.keyfile = ''
531
532## Metadata dictionary, which serves as the default top-level metadata dict for
533#  each message.
534#c.Session.metadata = {}
535
536## The name of the packer for serializing messages. Should be one of 'json',
537#  'pickle', or an import name for a custom callable serializer.
538#c.Session.packer = 'json'
539
540## The UUID identifying this session.
541#c.Session.session = ''
542
543## The digest scheme used to construct the message signatures. Must have the form
544#  'hmac-HASH'.
545#c.Session.signature_scheme = 'hmac-sha256'
546
547## The name of the unpacker for unserializing messages. Only used with custom
548#  functions for `packer`.
549#c.Session.unpacker = 'json'
550
551## Username for the Session. Default is your system username.
552#c.Session.username = 'username'
553
554#------------------------------------------------------------------------------
555# MultiKernelManager(LoggingConfigurable) configuration
556#------------------------------------------------------------------------------
557
558## A class for managing multiple kernels.
559
560## The name of the default kernel to start
561#c.MultiKernelManager.default_kernel_name = 'python3'
562
563## The kernel manager class.  This is configurable to allow subclassing of the
564#  KernelManager for customized behavior.
565#c.MultiKernelManager.kernel_manager_class = 'jupyter_client.ioloop.IOLoopKernelManager'
566
567## Share a single zmq.Context to talk to all my kernels
568#c.MultiKernelManager.shared_context = True
569
570#------------------------------------------------------------------------------
571# MappingKernelManager(MultiKernelManager) configuration
572#------------------------------------------------------------------------------
573
574## A KernelManager that handles notebook mapping and HTTP error handling
575
576## White list of allowed kernel message types. When the list is empty, all
577#  message types are allowed.
578#c.MappingKernelManager.allowed_message_types = []
579
580## Whether messages from kernels whose frontends have disconnected should be
581#  buffered in-memory.
582#
583#  When True (default), messages are buffered and replayed on reconnect, avoiding
584#  lost messages due to interrupted connectivity.
585#
586#  Disable if long-running kernels will produce too much output while no
587#  frontends are connected.
588#c.MappingKernelManager.buffer_offline_messages = True
589
590## Whether to consider culling kernels which are busy. Only effective if
591#  cull_idle_timeout > 0.
592#c.MappingKernelManager.cull_busy = False
593
594## Whether to consider culling kernels which have one or more connections. Only
595#  effective if cull_idle_timeout > 0.
596#c.MappingKernelManager.cull_connected = False
597
598## Timeout (in seconds) after which a kernel is considered idle and ready to be
599#  culled. Values of 0 or lower disable culling. Very short timeouts may result
600#  in kernels being culled for users with poor network connections.
601#c.MappingKernelManager.cull_idle_timeout = 0
602
603## The interval (in seconds) on which to check for idle kernels exceeding the
604#  cull timeout value.
605#c.MappingKernelManager.cull_interval = 300
606
607## Timeout for giving up on a kernel (in seconds).
608#
609#  On starting and restarting kernels, we check whether the kernel is running and
610#  responsive by sending kernel_info_requests. This sets the timeout in seconds
611#  for how long the kernel can take before being presumed dead. This affects the
612#  MappingKernelManager (which handles kernel restarts) and the
613#  ZMQChannelsHandler (which handles the startup).
614#c.MappingKernelManager.kernel_info_timeout = 60
615
616##
617#c.MappingKernelManager.root_dir = ''
618
619#------------------------------------------------------------------------------
620# KernelSpecManager(LoggingConfigurable) configuration
621#------------------------------------------------------------------------------
622
623## If there is no Python kernelspec registered and the IPython kernel is
624#  available, ensure it is added to the spec list.
625#c.KernelSpecManager.ensure_native_kernel = True
626
627## The kernel spec class.  This is configurable to allow subclassing of the
628#  KernelSpecManager for customized behavior.
629#c.KernelSpecManager.kernel_spec_class = 'jupyter_client.kernelspec.KernelSpec'
630
631## Whitelist of allowed kernel names.
632#
633#  By default, all installed kernels are allowed.
634#c.KernelSpecManager.whitelist = set()
635
636#------------------------------------------------------------------------------
637# ContentsManager(LoggingConfigurable) configuration
638#------------------------------------------------------------------------------
639
640## Base class for serving files and directories.
641#
642#  This serves any text or binary file, as well as directories, with special
643#  handling for JSON notebook documents.
644#
645#  Most APIs take a path argument, which is always an API-style unicode path, and
646#  always refers to a directory.
647#
648#  - unicode, not url-escaped
649#  - '/'-separated
650#  - leading and trailing '/' will be stripped
651#  - if unspecified, path defaults to '',
652#    indicating the root path.
653
654## Allow access to hidden files
655#c.ContentsManager.allow_hidden = False
656
657##
658#c.ContentsManager.checkpoints = None
659
660##
661#c.ContentsManager.checkpoints_class = 'notebook.services.contents.checkpoints.Checkpoints'
662
663##
664#c.ContentsManager.checkpoints_kwargs = {}
665
666## handler class to use when serving raw file requests.
667#
668#  Default is a fallback that talks to the ContentsManager API, which may be
669#  inefficient, especially for large files.
670#
671#  Local files-based ContentsManagers can use a StaticFileHandler subclass, which
672#  will be much more efficient.
673#
674#  Access to these files should be Authenticated.
675#c.ContentsManager.files_handler_class = 'notebook.files.handlers.FilesHandler'
676
677## Extra parameters to pass to files_handler_class.
678#
679#  For example, StaticFileHandlers generally expect a `path` argument specifying
680#  the root directory from which to serve files.
681#c.ContentsManager.files_handler_params = {}
682
683## Glob patterns to hide in file and directory listings.
684#c.ContentsManager.hide_globs = ['__pycache__', '*.pyc', '*.pyo', '.DS_Store', '*.so', '*.dylib', '*~']
685
686## Python callable or importstring thereof
687#
688#  To be called on a contents model prior to save.
689#
690#  This can be used to process the structure, such as removing notebook outputs
691#  or other side effects that should not be saved.
692#
693#  It will be called as (all arguments passed by keyword)::
694#
695#      hook(path=path, model=model, contents_manager=self)
696#
697#  - model: the model to be saved. Includes file contents.
698#    Modifying this dict will affect the file that is stored.
699#  - path: the API path of the save destination
700#  - contents_manager: this ContentsManager instance
701#c.ContentsManager.pre_save_hook = None
702
703##
704#c.ContentsManager.root_dir = '/'
705
706## The base name used when creating untitled directories.
707#c.ContentsManager.untitled_directory = 'Untitled Folder'
708
709## The base name used when creating untitled files.
710#c.ContentsManager.untitled_file = 'untitled'
711
712## The base name used when creating untitled notebooks.
713#c.ContentsManager.untitled_notebook = 'Untitled'
714
715#------------------------------------------------------------------------------
716# FileManagerMixin(Configurable) configuration
717#------------------------------------------------------------------------------
718
719## Mixin for ContentsAPI classes that interact with the filesystem.
720#
721#  Provides facilities for reading, writing, and copying both notebooks and
722#  generic files.
723#
724#  Shared by FileContentsManager and FileCheckpoints.
725#
726#  Note ---- Classes using this mixin must provide the following attributes:
727#
728#  root_dir : unicode
729#      A directory against against which API-style paths are to be resolved.
730#
731#  log : logging.Logger
732
733## By default notebooks are saved on disk on a temporary file and then if
734#  successfully written, it replaces the old ones. This procedure, namely
735#  'atomic_writing', causes some bugs on file system without operation order
736#  enforcement (like some networked fs). If set to False, the new notebook is
737#  written directly on the old one which could fail (eg: full filesystem or quota
738#  )
739#c.FileManagerMixin.use_atomic_writing = True
740
741#------------------------------------------------------------------------------
742# FileContentsManager(FileManagerMixin,ContentsManager) configuration
743#------------------------------------------------------------------------------
744
745## If True (default), deleting files will send them to the platform's
746#  trash/recycle bin, where they can be recovered. If False, deleting files
747#  really deletes them.
748#c.FileContentsManager.delete_to_trash = True
749
750## Python callable or importstring thereof
751#
752#  to be called on the path of a file just saved.
753#
754#  This can be used to process the file on disk, such as converting the notebook
755#  to a script or HTML via nbconvert.
756#
757#  It will be called as (all arguments passed by keyword)::
758#
759#      hook(os_path=os_path, model=model, contents_manager=instance)
760#
761#  - path: the filesystem path to the file just written - model: the model
762#  representing the file - contents_manager: this ContentsManager instance
763#c.FileContentsManager.post_save_hook = None
764
765##
766#c.FileContentsManager.root_dir = ''
767
768## DEPRECATED, use post_save_hook. Will be removed in Notebook 5.0
769#c.FileContentsManager.save_script = False
770
771#------------------------------------------------------------------------------
772# NotebookNotary(LoggingConfigurable) configuration
773#------------------------------------------------------------------------------
774
775## A class for computing and verifying notebook signatures.
776
777## The hashing algorithm used to sign notebooks.
778#c.NotebookNotary.algorithm = 'sha256'
779
780## The sqlite file in which to store notebook signatures. By default, this will
781#  be in your Jupyter data directory. You can set it to ':memory:' to disable
782#  sqlite writing to the filesystem.
783#c.NotebookNotary.db_file = ''
784
785## The secret key with which notebooks are signed.
786#c.NotebookNotary.secret = b''
787
788## The file where the secret key is stored.
789#c.NotebookNotary.secret_file = ''
790
791## A callable returning the storage backend for notebook signatures. The default
792#  uses an SQLite database.
793#c.NotebookNotary.store_factory = traitlets.Undefined
794
795#------------------------------------------------------------------------------
796# GatewayKernelManager(MappingKernelManager) configuration
797#------------------------------------------------------------------------------
798
799## Kernel manager that supports remote kernels hosted by Jupyter Kernel or
800#  Enterprise Gateway.
801
802#------------------------------------------------------------------------------
803# GatewayKernelSpecManager(KernelSpecManager) configuration
804#------------------------------------------------------------------------------
805
806#------------------------------------------------------------------------------
807# GatewayClient(SingletonConfigurable) configuration
808#------------------------------------------------------------------------------
809
810## This class manages the configuration.  It's its own singleton class so that we
811#  can share these values across all objects.  It also contains some helper methods
812#   to build request arguments out of the various config options.
813
814## The authorization token used in the HTTP headers.  (JUPYTER_GATEWAY_AUTH_TOKEN
815#  env var)
816#c.GatewayClient.auth_token = None
817
818## The filename of CA certificates or None to use defaults.
819#  (JUPYTER_GATEWAY_CA_CERTS env var)
820#c.GatewayClient.ca_certs = None
821
822## The filename for client SSL certificate, if any.  (JUPYTER_GATEWAY_CLIENT_CERT
823#  env var)
824#c.GatewayClient.client_cert = None
825
826## The filename for client SSL key, if any.  (JUPYTER_GATEWAY_CLIENT_KEY env var)
827#c.GatewayClient.client_key = None
828
829## The time allowed for HTTP connection establishment with the Gateway server.
830#  (JUPYTER_GATEWAY_CONNECT_TIMEOUT env var)
831#c.GatewayClient.connect_timeout = 60.0
832
833## A comma-separated list of environment variable names that will be included,
834#  along with their values, in the kernel startup request.  The corresponding
835#  `env_whitelist` configuration value must also be set on the Gateway server -
836#  since that configuration value indicates which environmental values to make
837#  available to the kernel. (JUPYTER_GATEWAY_ENV_WHITELIST env var)
838#c.GatewayClient.env_whitelist = ''
839
840## Additional HTTP headers to pass on the request.  This value will be converted
841#  to a dict. (JUPYTER_GATEWAY_HEADERS env var)
842#c.GatewayClient.headers = '{}'
843
844## The password for HTTP authentication.  (JUPYTER_GATEWAY_HTTP_PWD env var)
845#c.GatewayClient.http_pwd = None
846
847## The username for HTTP authentication. (JUPYTER_GATEWAY_HTTP_USER env var)
848#c.GatewayClient.http_user = None
849
850## The gateway API endpoint for accessing kernel resources
851#  (JUPYTER_GATEWAY_KERNELS_ENDPOINT env var)
852#c.GatewayClient.kernels_endpoint = '/api/kernels'
853
854## The gateway API endpoint for accessing kernelspecs
855#  (JUPYTER_GATEWAY_KERNELSPECS_ENDPOINT env var)
856#c.GatewayClient.kernelspecs_endpoint = '/api/kernelspecs'
857
858## The gateway endpoint for accessing kernelspecs resources
859#  (JUPYTER_GATEWAY_KERNELSPECS_RESOURCE_ENDPOINT env var)
860#c.GatewayClient.kernelspecs_resource_endpoint = '/kernelspecs'
861
862## The time allowed for HTTP request completion. (JUPYTER_GATEWAY_REQUEST_TIMEOUT
863#  env var)
864#c.GatewayClient.request_timeout = 60.0
865
866## The url of the Kernel or Enterprise Gateway server where kernel specifications
867#  are defined and kernel management takes place. If defined, this Notebook
868#  server acts as a proxy for all kernel management and kernel specification
869#  retrieval.  (JUPYTER_GATEWAY_URL env var)
870#c.GatewayClient.url = None
871
872## For HTTPS requests, determines if server's certificate should be validated or
873#  not. (JUPYTER_GATEWAY_VALIDATE_CERT env var)
874#c.GatewayClient.validate_cert = True
875
876## The websocket url of the Kernel or Enterprise Gateway server.  If not
877#  provided, this value will correspond to the value of the Gateway url with 'ws'
878#  in place of 'http'.  (JUPYTER_GATEWAY_WS_URL env var)
879#c.GatewayClient.ws_url = None
880