# Configuration file for jupyter-server. c = get_config() #noqa # The following based on ChatGTP prompt: # # I am setting up a Jupyter notebook server that operates through an https reverse-proxied Apache2 web server. I am on a headless server, using "jupyter server" c.ServerApp.ip = '127.0.0.1' # Only listen on localhost c.ServerApp.port = 8888 # Port Jupyter Server will run on c.ServerApp.open_browser = False # Prevents opening a browser c.ServerApp.allow_remote_access = True # Allow access through the proxy c.ServerApp.base_url = '/mdq/' # Match Apache's ProxyPass settings #c.ServerApp.webapp_settings = { 'static_url_prefix':'/mdq/static/' } c.ServerApp.extra_static_paths = [ '/mdq/static/' ] c.ServerApp.trust_xheaders = True # Handle headers properly c.ServerApp.token = '' # Disable token authentication (use Apache authentication instead) c.ServerApp.disable_check_xsrf = True # Avoid proxy issues c.ServerApp.allow_origin = '*' # Allow connections from all origins (adjust as needed) #------------------------------------------------------------------------------ # Application(SingletonConfigurable) configuration #------------------------------------------------------------------------------ ## This is an application. ## The date format used by logging formatters for %(asctime)s # Default: '%Y-%m-%d %H:%M:%S' # c.Application.log_datefmt = '%Y-%m-%d %H:%M:%S' ## The Logging format template # Default: '[%(name)s]%(highlevel)s %(message)s' # c.Application.log_format = '[%(name)s]%(highlevel)s %(message)s' ## Set the log level by value or name. # Choices: any of [0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'] # Default: 30 # c.Application.log_level = 30 ## Configure additional log handlers. # # The default stderr logs handler is configured by the log_level, log_datefmt # and log_format settings. # # This configuration can be used to configure additional handlers (e.g. to # output the log to a file) or for finer control over the default handlers. # # If provided this should be a logging configuration dictionary, for more # information see: # https://docs.python.org/3/library/logging.config.html#logging-config- # dictschema # # This dictionary is merged with the base logging configuration which defines # the following: # # * A logging formatter intended for interactive use called # ``console``. # * A logging handler that writes to stderr called # ``console`` which uses the formatter ``console``. # * A logger with the name of this application set to ``DEBUG`` # level. # # This example adds a new handler that writes to a file: # # .. code-block:: python # # c.Application.logging_config = { # "handlers": { # "file": { # "class": "logging.FileHandler", # "level": "DEBUG", # "filename": "", # } # }, # "loggers": { # "": { # "level": "DEBUG", # # NOTE: if you don't list the default "console" # # handler here then it will be disabled # "handlers": ["console", "file"], # }, # }, # } # Default: {} # c.Application.logging_config = {} ## Instead of starting the Application, dump configuration to stdout # Default: False # c.Application.show_config = False ## Instead of starting the Application, dump configuration to stdout (as JSON) # Default: False # c.Application.show_config_json = False #------------------------------------------------------------------------------ # JupyterApp(Application) configuration #------------------------------------------------------------------------------ ## Base class for Jupyter applications ## Answer yes to any prompts. # Default: False # c.JupyterApp.answer_yes = False ## Full path of a config file. # Default: '' # c.JupyterApp.config_file = '' ## Specify a config file to load. # Default: '' # c.JupyterApp.config_file_name = '' ## Generate default config file. # Default: False # c.JupyterApp.generate_config = False ## The date format used by logging formatters for %(asctime)s # See also: Application.log_datefmt # c.JupyterApp.log_datefmt = '%Y-%m-%d %H:%M:%S' ## The Logging format template # See also: Application.log_format # c.JupyterApp.log_format = '[%(name)s]%(highlevel)s %(message)s' ## Set the log level by value or name. # See also: Application.log_level # c.JupyterApp.log_level = 30 ## # See also: Application.logging_config # c.JupyterApp.logging_config = {} ## Instead of starting the Application, dump configuration to stdout # See also: Application.show_config # c.JupyterApp.show_config = False ## Instead of starting the Application, dump configuration to stdout (as JSON) # See also: Application.show_config_json # c.JupyterApp.show_config_json = False #------------------------------------------------------------------------------ # ServerApp(JupyterApp) configuration #------------------------------------------------------------------------------ ## The Jupyter Server application class. ## Set the Access-Control-Allow-Credentials: true header # Default: False # c.ServerApp.allow_credentials = False ## Whether or not to allow external kernels, whose connection files are placed in # external_connection_dir. # Default: False # c.ServerApp.allow_external_kernels = False ## Set the Access-Control-Allow-Origin header # # Use '*' to allow any origin to access your server. # # Takes precedence over allow_origin_pat. # Default: '' # c.ServerApp.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. # Default: '' # c.ServerApp.allow_origin_pat = '' ## DEPRECATED in 2.0. Use PasswordIdentityProvider.allow_password_change # Default: True # c.ServerApp.allow_password_change = True ## Allow requests where the Host header doesn't point to a local server # # By default, requests get a 403 forbidden response if the 'Host' header # shows that the browser thinks it's on a non-local domain. # Setting this option to True disables this check. # # This protects against 'DNS rebinding' attacks, where a remote web server # serves you a page and then changes its DNS to send later requests to a # local IP, bypassing same-origin checks. # # Local IP addresses (such as 127.0.0.1 and ::1) are allowed as local, # along with hostnames configured in local_hostnames. # Default: False # c.ServerApp.allow_remote_access = False ## Whether to allow the user to run the server as root. # Default: False # c.ServerApp.allow_root = False ## Allow unauthenticated access to endpoints without authentication rule. # # When set to `True` (default in jupyter-server 2.0, subject to change # in the future), any request to an endpoint without an authentication rule # (either `@tornado.web.authenticated`, or `@allow_unauthenticated`) # will be permitted, regardless of whether user has logged in or not. # # When set to `False`, logging in will be required for access to each endpoint, # excluding the endpoints marked with `@allow_unauthenticated` decorator. # # This option can be configured using `JUPYTER_SERVER_ALLOW_UNAUTHENTICATED_ACCESS` # environment variable: any non-empty value other than "true" and "yes" will # prevent unauthenticated access to endpoints without `@allow_unauthenticated`. # Default: True # c.ServerApp.allow_unauthenticated_access = True ## Answer yes to any prompts. # See also: JupyterApp.answer_yes # c.ServerApp.answer_yes = False ## " # Require authentication to access prometheus metrics. # Default: True # c.ServerApp.authenticate_prometheus = True ## The authorizer class to use. # Default: 'jupyter_server.auth.authorizer.AllowAllAuthorizer' # c.ServerApp.authorizer_class = 'jupyter_server.auth.authorizer.AllowAllAuthorizer' ## Reload the webapp when changes are made to any Python src files. # Default: False # c.ServerApp.autoreload = False ## The base URL for the Jupyter server. # # Leading and trailing slashes can be omitted, # and will automatically be added. # Default: '/' # c.ServerApp.base_url = '/' ## Specify what command to use to invoke a web # browser when starting the server. 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. # Default: '' # c.ServerApp.browser = '' ## The full path to an SSL/TLS certificate file. # Default: '' # c.ServerApp.certfile = '' ## The full path to a certificate authority certificate for SSL/TLS client # authentication. # Default: '' # c.ServerApp.client_ca = '' ## Full path of a config file. # See also: JupyterApp.config_file # c.ServerApp.config_file = '' ## Specify a config file to load. # See also: JupyterApp.config_file_name # c.ServerApp.config_file_name = '' ## The config manager class to use # Default: 'jupyter_server.services.config.manager.ConfigManager' # c.ServerApp.config_manager_class = 'jupyter_server.services.config.manager.ConfigManager' ## The content manager class to use. # Default: 'jupyter_server.services.contents.largefilemanager.AsyncLargeFileManager' # c.ServerApp.contents_manager_class = 'jupyter_server.services.contents.largefilemanager.AsyncLargeFileManager' ## DEPRECATED. Use IdentityProvider.cookie_options # Default: {} # c.ServerApp.cookie_options = {} ## The random bytes used to secure cookies. # By default this is generated on first start of the server and persisted across server # sessions by writing the cookie secret into the `cookie_secret_file` file. # When using an executable config file you can override this to be random at each server restart. # # 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). # Default: b'' # c.ServerApp.cookie_secret = b'' ## The file where the cookie secret is stored. # Default: '' # c.ServerApp.cookie_secret_file = '' ## Override URL shown to users. # # Replace actual URL, including protocol, address, port and base URL, # with the given value when displaying URL to the users. Do not change # the actual connection URL. If authentication token is enabled, the # token is added to the custom URL automatically. # # This option is intended to be used when the URL to display to the user # cannot be determined reliably by the Jupyter server (proxified # or containerized setups for example). # Default: '' # c.ServerApp.custom_display_url = '' ## The default URL to redirect to from `/` # Default: '/' # c.ServerApp.default_url = '/' ## Disable cross-site-request-forgery protection # # Jupyter server includes 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. # Default: False # c.ServerApp.disable_check_xsrf = False ## The directory to look at for external kernel connection files, if # allow_external_kernels is True. Defaults to Jupyter # runtime_dir/external_kernels. Make sure that this directory is not filled with # left-over connection files, that could result in unnecessary kernel manager # creations. # Default: None # c.ServerApp.external_connection_dir = None ## handlers that should be loaded at higher priority than the default services # Default: [] # c.ServerApp.extra_services = [] ## Extra paths to search for serving static files. # # This allows adding javascript/css to be available from the Jupyter server machine, # or overriding individual files in the IPython # Default: [] # c.ServerApp.extra_static_paths = [] ## Extra paths to search for serving jinja templates. # # Can be used to override templates from jupyter_server.templates. # Default: [] # c.ServerApp.extra_template_paths = [] ## Open the named file when the application is launched. # Default: '' # c.ServerApp.file_to_run = '' ## The URL prefix where files are opened directly. # Default: 'notebooks' # c.ServerApp.file_url_prefix = 'notebooks' ## Generate default config file. # See also: JupyterApp.generate_config # c.ServerApp.generate_config = False ## DEPRECATED. Use IdentityProvider.get_secure_cookie_kwargs # Default: {} # c.ServerApp.get_secure_cookie_kwargs = {} ## The identity provider class to use. # Default: 'jupyter_server.auth.identity.PasswordIdentityProvider' # c.ServerApp.identity_provider_class = 'jupyter_server.auth.identity.PasswordIdentityProvider' ## DEPRECATED. Use ZMQChannelsWebsocketConnection.iopub_data_rate_limit # Default: 0.0 # c.ServerApp.iopub_data_rate_limit = 0.0 ## DEPRECATED. Use ZMQChannelsWebsocketConnection.iopub_msg_rate_limit # Default: 0.0 # c.ServerApp.iopub_msg_rate_limit = 0.0 ## The IP address the Jupyter server will listen on. # Default: 'localhost' # c.ServerApp.ip = 'localhost' ## Supply extra arguments that will be passed to Jinja environment. # Default: {} # c.ServerApp.jinja_environment_options = {} ## Extra variables to supply to jinja templates when rendering. # Default: {} # c.ServerApp.jinja_template_vars = {} ## Dict of Python modules to load as Jupyter server extensions.Entry values can # be used to enable and disable the loading ofthe extensions. The extensions # will be loaded in alphabetical order. # Default: {} # c.ServerApp.jpserver_extensions = {} ## The kernel manager class to use. # Default: 'jupyter_server.services.kernels.kernelmanager.MappingKernelManager' # c.ServerApp.kernel_manager_class = 'jupyter_server.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. # Default: 'builtins.object' # c.ServerApp.kernel_spec_manager_class = 'builtins.object' ## The kernel websocket connection class to use. # Default: 'jupyter_server.services.kernels.connection.base.BaseKernelWebsocketConnection' # c.ServerApp.kernel_websocket_connection_class = 'jupyter_server.services.kernels.connection.base.BaseKernelWebsocketConnection' ## DEPRECATED. Use ZMQChannelsWebsocketConnection.kernel_ws_protocol # Default: '' # c.ServerApp.kernel_ws_protocol = '' ## The full path to a private key file for usage with SSL/TLS. # Default: '' # c.ServerApp.keyfile = '' ## DEPRECATED. Use ZMQChannelsWebsocketConnection.limit_rate # Default: False # c.ServerApp.limit_rate = False ## Hostnames to allow as local when allow_remote_access is False. # # Local IP addresses (such as 127.0.0.1 and ::1) are automatically accepted # as local as well. # Default: ['localhost'] # c.ServerApp.local_hostnames = ['localhost'] ## The date format used by logging formatters for %(asctime)s # See also: Application.log_datefmt # c.ServerApp.log_datefmt = '%Y-%m-%d %H:%M:%S' ## The Logging format template # See also: Application.log_format # c.ServerApp.log_format = '[%(name)s]%(highlevel)s %(message)s' ## Set the log level by value or name. # See also: Application.log_level # c.ServerApp.log_level = 30 ## # See also: Application.logging_config # c.ServerApp.logging_config = {} ## The login handler class to use. # Default: 'jupyter_server.auth.login.LegacyLoginHandler' # c.ServerApp.login_handler_class = 'jupyter_server.auth.login.LegacyLoginHandler' ## The logout handler class to use. # Default: 'jupyter_server.auth.logout.LogoutHandler' # c.ServerApp.logout_handler_class = 'jupyter_server.auth.logout.LogoutHandler' ## Sets the maximum allowed size of the client request body, specified in the # Content-Length request header field. If the size in a request exceeds the # configured value, a malformed HTTP message is returned to the client. # # Note: max_body_size is applied even in streaming mode. # Default: 536870912 # c.ServerApp.max_body_size = 536870912 ## Gets or sets the maximum amount of memory, in bytes, that is allocated for use # by the buffer manager. # Default: 536870912 # c.ServerApp.max_buffer_size = 536870912 ## Gets or sets a lower bound on the open file handles process resource limit. # This may need to be increased if you run into an OSError: [Errno 24] Too many # open files. This is not applicable when running on Windows. # Default: 0 # c.ServerApp.min_open_files_limit = 0 ## DEPRECATED, use root_dir. # Default: '' # c.ServerApp.notebook_dir = '' ## 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 # (ServerApp.browser) configuration option. # Default: False # c.ServerApp.open_browser = False ## DEPRECATED in 2.0. Use PasswordIdentityProvider.hashed_password # Default: '' # c.ServerApp.password = '' ## DEPRECATED in 2.0. Use PasswordIdentityProvider.password_required # Default: False # c.ServerApp.password_required = False ## The port the server will listen on (env: JUPYTER_PORT). # Default: 0 # c.ServerApp.port = 0 ## The number of additional ports to try if the specified port is not available # (env: JUPYTER_PORT_RETRIES). # Default: 50 # c.ServerApp.port_retries = 50 ## Preferred starting directory to use for notebooks and kernels. # ServerApp.preferred_dir is deprecated in jupyter-server 2.0. Use # FileContentsManager.preferred_dir instead # Default: '' # c.ServerApp.preferred_dir = '' ## DISABLED: use %pylab or %matplotlib in the notebook to enable matplotlib. # Default: 'disabled' # c.ServerApp.pylab = 'disabled' ## If True, display controls to shut down the Jupyter server, such as menu items # or buttons. # Default: True # c.ServerApp.quit_button = True ## DEPRECATED. Use ZMQChannelsWebsocketConnection.rate_limit_window # Default: 0.0 # c.ServerApp.rate_limit_window = 0.0 ## Reraise exceptions encountered loading server extensions? # Default: False # c.ServerApp.reraise_server_extension_failures = False ## The directory to use for notebooks and kernels. # Default: '' # c.ServerApp.root_dir = '' ## The session manager class to use. # Default: 'builtins.object' # c.ServerApp.session_manager_class = 'builtins.object' ## Instead of starting the Application, dump configuration to stdout # See also: Application.show_config # c.ServerApp.show_config = False ## Instead of starting the Application, dump configuration to stdout (as JSON) # See also: Application.show_config_json # c.ServerApp.show_config_json = False ## Shut down the server after N seconds with no kernelsrunning and no activity. # This can be used together with culling idle kernels # (MappingKernelManager.cull_idle_timeout) to shutdown the Jupyter server when # it's not in use. This is not precisely timed: it may shut down up to a minute # later. 0 (the default) disables this automatic shutdown. # Default: 0 # c.ServerApp.shutdown_no_activity_timeout = 0 ## The UNIX socket the Jupyter server will listen on. # Default: '' # c.ServerApp.sock = '' ## The permissions mode for UNIX socket creation (default: 0600). # Default: '0600' # c.ServerApp.sock_mode = '0600' ## Supply SSL options for the tornado HTTPServer. # See the tornado docs for details. # Default: {} # c.ServerApp.ssl_options = {} ## Paths to set up static files as immutable. # # This allow setting up the cache control of static files as immutable. It # should be used for static file named with a hash for instance. # Default: [] # c.ServerApp.static_immutable_cache = [] ## Supply overrides for terminado. Currently only supports "shell_command". # Default: {} # c.ServerApp.terminado_settings = {} ## Set to False to disable terminals. # # This does *not* make the server more secure by itself. # Anything the user can in a terminal, they can also do in a notebook. # # Terminals may also be automatically disabled if the terminado package # is not available. # Default: False # c.ServerApp.terminals_enabled = False ## DEPRECATED. Use IdentityProvider.token # Default: '' # c.ServerApp.token = '' ## Supply overrides for the tornado.web.Application that the Jupyter server uses. # Default: {} # c.ServerApp.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 # Default: False # c.ServerApp.trust_xheaders = False ## Disable launching browser by redirect file # For versions of notebook > 5.7.2, a security feature measure was added that # prevented the authentication token used to launch the browser from being visible. # This feature makes it difficult for other users on a multi-user system from # running code in your Jupyter session as you. # However, some environments (like Windows Subsystem for Linux (WSL) and Chromebooks), # launching a browser using a redirect file can lead the browser failing to load. # This is because of the difference in file structures/paths between the runtime and # the browser. # # Disabling this setting to False will disable this behavior, allowing the browser # to launch by using a URL and visible token (as before). # Default: True # c.ServerApp.use_redirect_file = True ## Specify where to open the server on startup. This is the # `new` argument passed to the standard library method `webbrowser.open`. # The behaviour is not guaranteed, but depends on browser support. Valid # values are: # # - 2 opens a new tab, # - 1 opens a new window, # - 0 opens in an existing window. # # See the `webbrowser.open` documentation for details. # Default: 2 # c.ServerApp.webbrowser_open_new = 2 ## Set the tornado compression options for websocket connections. # # This value will be returned from # :meth:`WebSocketHandler.get_compression_options`. None (default) will disable # compression. A dict (even an empty one) will enable compression. # # See the tornado docs for WebSocketHandler.get_compression_options for details. # Default: None # c.ServerApp.websocket_compression_options = None ## Configure the websocket ping interval in seconds. # # Websockets are long-lived connections that are used by some Jupyter Server # extensions. # # Periodic pings help to detect disconnected clients and keep the connection # active. If this is set to None, then no pings will be performed. # # When a ping is sent, the client has ``websocket_ping_timeout`` seconds to # respond. If no response is received within this period, the connection will be # closed from the server side. # Default: 0 # c.ServerApp.websocket_ping_interval = 0 ## Configure the websocket ping timeout in seconds. # # See ``websocket_ping_interval`` for details. # Default: 0 # c.ServerApp.websocket_ping_timeout = 0 ## 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] # Default: '' # c.ServerApp.websocket_url = '' #------------------------------------------------------------------------------ # ConnectionFileMixin(LoggingConfigurable) configuration #------------------------------------------------------------------------------ ## Mixin for configurable classes that work with connection files ## JSON file in which to store connection info [default: kernel-.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. # Default: '' # c.ConnectionFileMixin.connection_file = '' ## set the control (ROUTER) port [default: random] # Default: 0 # c.ConnectionFileMixin.control_port = 0 ## set the heartbeat port [default: random] # Default: 0 # c.ConnectionFileMixin.hb_port = 0 ## set the iopub (PUB) port [default: random] # Default: 0 # 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! # Default: '' # c.ConnectionFileMixin.ip = '' ## set the shell (ROUTER) port [default: random] # Default: 0 # c.ConnectionFileMixin.shell_port = 0 ## set the stdin (ROUTER) port [default: random] # Default: 0 # c.ConnectionFileMixin.stdin_port = 0 # Choices: any of ['tcp', 'ipc'] (case-insensitive) # Default: 'tcp' # 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. # Default: True # c.KernelManager.autorestart = True ## True if the MultiKernelManager should cache ports for this KernelManager # instance # Default: False # c.KernelManager.cache_ports = False ## JSON file in which to store connection info [default: kernel-.json] # See also: ConnectionFileMixin.connection_file # c.KernelManager.connection_file = '' ## set the control (ROUTER) port [default: random] # See also: ConnectionFileMixin.control_port # c.KernelManager.control_port = 0 ## set the heartbeat port [default: random] # See also: ConnectionFileMixin.hb_port # c.KernelManager.hb_port = 0 ## set the iopub (PUB) port [default: random] # See also: ConnectionFileMixin.iopub_port # c.KernelManager.iopub_port = 0 ## Set the kernel's IP address [default localhost]. # See also: ConnectionFileMixin.ip # c.KernelManager.ip = '' ## set the shell (ROUTER) port [default: random] # See also: ConnectionFileMixin.shell_port # c.KernelManager.shell_port = 0 ## Time to wait for a kernel to terminate before killing it, in seconds. When a # shutdown request is initiated, the kernel will be immediately sent an # interrupt (SIGINT), followedby a shutdown_request message, after 1/2 of # `shutdown_wait_time`it will be sent a terminate (SIGTERM) request, and finally # at the end of `shutdown_wait_time` will be killed (SIGKILL). terminate and # kill may be equivalent on windows. Note that this value can beoverridden by # the in-use kernel provisioner since shutdown times mayvary by provisioned # environment. # Default: 5.0 # c.KernelManager.shutdown_wait_time = 5.0 ## set the stdin (ROUTER) port [default: random] # See also: ConnectionFileMixin.stdin_port # c.KernelManager.stdin_port = 0 # See also: ConnectionFileMixin.transport # c.KernelManager.transport = 'tcp' #------------------------------------------------------------------------------ # 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. # Default: 1024 # 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. # Default: True # c.Session.check_pid = True ## Threshold (in bytes) beyond which a buffer should be sent without copying. # Default: 65536 # c.Session.copy_threshold = 65536 ## Debug output in the Session # Default: False # c.Session.debug = False ## The maximum number of digests to remember. # # The digest history will be culled when it exceeds this value. # Default: 65536 # 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. # Default: 64 # c.Session.item_threshold = 64 ## execution key, for signing messages. # Default: b'' # c.Session.key = b'' ## path to file containing execution key. # Default: '' # c.Session.keyfile = '' ## Metadata dictionary, which serves as the default top-level metadata dict for # each message. # Default: {} # 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. # Default: 'json' # c.Session.packer = 'json' ## The UUID identifying this session. # Default: '' # c.Session.session = '' ## The digest scheme used to construct the message signatures. # Must have the form 'hmac-HASH'. # Default: 'hmac-sha256' # c.Session.signature_scheme = 'hmac-sha256' ## The name of the unpacker for unserializing messages. # Only used with custom functions for `packer`. # Default: 'json' # c.Session.unpacker = 'json' ## Username for the Session. Default is your system username. # Default: 'dbbridge' # c.Session.username = 'dbbridge' #------------------------------------------------------------------------------ # MultiKernelManager(LoggingConfigurable) configuration #------------------------------------------------------------------------------ ## A class for managing multiple kernels. ## The name of the default kernel to start # Default: 'python3' # c.MultiKernelManager.default_kernel_name = 'python3' ## The kernel manager class. This is configurable to allow # subclassing of the KernelManager for customized behavior. # Default: 'jupyter_client.ioloop.IOLoopKernelManager' # c.MultiKernelManager.kernel_manager_class = 'jupyter_client.ioloop.IOLoopKernelManager' ## Share a single zmq.Context to talk to all my kernels # Default: True # c.MultiKernelManager.shared_context = True #------------------------------------------------------------------------------ # MappingKernelManager(MultiKernelManager) configuration #------------------------------------------------------------------------------ ## A KernelManager that handles # - File mapping # - HTTP error handling # - Kernel message filtering ## Whether to send tracebacks to clients on exceptions. # Default: True # c.MappingKernelManager.allow_tracebacks = True ## White list of allowed kernel message types. # When the list is empty, all message types are allowed. # Default: [] # c.MappingKernelManager.allowed_message_types = [] ## Whether messages from kernels whose frontends have disconnected should be # buffered in-memory. # # When True (default), messages are buffered and replayed on reconnect, # avoiding lost messages due to interrupted connectivity. # # Disable if long-running kernels will produce too much output while # no frontends are connected. # Default: True # c.MappingKernelManager.buffer_offline_messages = True ## Whether to consider culling kernels which are busy. # Only effective if cull_idle_timeout > 0. # Default: False # c.MappingKernelManager.cull_busy = False ## Whether to consider culling kernels which have one or more connections. # Only effective if cull_idle_timeout > 0. # Default: False # c.MappingKernelManager.cull_connected = False ## Timeout (in seconds) after which a kernel is considered idle and ready to be culled. # Values of 0 or lower disable culling. Very short timeouts may result in kernels being culled # for users with poor network connections. # Default: 0 # c.MappingKernelManager.cull_idle_timeout = 0 ## The interval (in seconds) on which to check for idle kernels exceeding the # cull timeout value. # Default: 300 # c.MappingKernelManager.cull_interval = 300 ## The name of the default kernel to start # See also: MultiKernelManager.default_kernel_name # c.MappingKernelManager.default_kernel_name = 'python3' ## Timeout for giving up on a kernel (in seconds). # # On starting and restarting kernels, we check whether the # kernel is running and responsive by sending kernel_info_requests. # This sets the timeout in seconds for how long the kernel can take # before being presumed dead. # This affects the MappingKernelManager (which handles kernel restarts) # and the ZMQChannelsHandler (which handles the startup). # Default: 60 # c.MappingKernelManager.kernel_info_timeout = 60 ## The kernel manager class. This is configurable to allow # See also: MultiKernelManager.kernel_manager_class # c.MappingKernelManager.kernel_manager_class = 'jupyter_client.ioloop.IOLoopKernelManager' # Default: '' # c.MappingKernelManager.root_dir = '' ## Share a single zmq.Context to talk to all my kernels # See also: MultiKernelManager.shared_context # c.MappingKernelManager.shared_context = True ## Message to print when allow_tracebacks is False, and an exception occurs # Default: 'An exception occurred at runtime, which is not shown due to security reasons.' # c.MappingKernelManager.traceback_replacement_message = 'An exception occurred at runtime, which is not shown due to security reasons.' #------------------------------------------------------------------------------ # KernelSpecManager(LoggingConfigurable) configuration #------------------------------------------------------------------------------ ## A manager for kernel specs. ## List of allowed kernel names. # # By default, all installed kernels are allowed. # Default: set() # c.KernelSpecManager.allowed_kernelspecs = set() ## If there is no Python kernelspec registered and the IPython # kernel is available, ensure it is added to the spec list. # Default: True # c.KernelSpecManager.ensure_native_kernel = True ## The kernel spec class. This is configurable to allow # subclassing of the KernelSpecManager for customized behavior. # Default: 'jupyter_client.kernelspec.KernelSpec' # c.KernelSpecManager.kernel_spec_class = 'jupyter_client.kernelspec.KernelSpec' ## Deprecated, use `KernelSpecManager.allowed_kernelspecs` # Default: set() # c.KernelSpecManager.whitelist = set() #------------------------------------------------------------------------------ # AsyncMultiKernelManager(MultiKernelManager) configuration #------------------------------------------------------------------------------ ## The name of the default kernel to start # See also: MultiKernelManager.default_kernel_name # c.AsyncMultiKernelManager.default_kernel_name = 'python3' ## The kernel manager class. This is configurable to allow # subclassing of the AsyncKernelManager for customized behavior. # Default: 'jupyter_client.ioloop.AsyncIOLoopKernelManager' # c.AsyncMultiKernelManager.kernel_manager_class = 'jupyter_client.ioloop.AsyncIOLoopKernelManager' ## Share a single zmq.Context to talk to all my kernels # See also: MultiKernelManager.shared_context # c.AsyncMultiKernelManager.shared_context = True ## Whether to make kernels available before the process has started. The # kernel has a `.ready` future which can be awaited before connecting # Default: False # c.AsyncMultiKernelManager.use_pending_kernels = False #------------------------------------------------------------------------------ # AsyncMappingKernelManager(MappingKernelManager, AsyncMultiKernelManager) configuration #------------------------------------------------------------------------------ ## An asynchronous mapping kernel manager. ## Whether to send tracebacks to clients on exceptions. # See also: MappingKernelManager.allow_tracebacks # c.AsyncMappingKernelManager.allow_tracebacks = True ## White list of allowed kernel message types. # See also: MappingKernelManager.allowed_message_types # c.AsyncMappingKernelManager.allowed_message_types = [] ## Whether messages from kernels whose frontends have disconnected should be # buffered in-memory. # See also: MappingKernelManager.buffer_offline_messages # c.AsyncMappingKernelManager.buffer_offline_messages = True ## Whether to consider culling kernels which are busy. # See also: MappingKernelManager.cull_busy # c.AsyncMappingKernelManager.cull_busy = False ## Whether to consider culling kernels which have one or more connections. # See also: MappingKernelManager.cull_connected # c.AsyncMappingKernelManager.cull_connected = False ## Timeout (in seconds) after which a kernel is considered idle and ready to be # culled. # See also: MappingKernelManager.cull_idle_timeout # c.AsyncMappingKernelManager.cull_idle_timeout = 0 ## The interval (in seconds) on which to check for idle kernels exceeding the # cull timeout value. # See also: MappingKernelManager.cull_interval # c.AsyncMappingKernelManager.cull_interval = 300 ## The name of the default kernel to start # See also: MultiKernelManager.default_kernel_name # c.AsyncMappingKernelManager.default_kernel_name = 'python3' ## Timeout for giving up on a kernel (in seconds). # See also: MappingKernelManager.kernel_info_timeout # c.AsyncMappingKernelManager.kernel_info_timeout = 60 ## The kernel manager class. This is configurable to allow # See also: AsyncMultiKernelManager.kernel_manager_class # c.AsyncMappingKernelManager.kernel_manager_class = 'jupyter_client.ioloop.AsyncIOLoopKernelManager' # See also: MappingKernelManager.root_dir # c.AsyncMappingKernelManager.root_dir = '' ## Share a single zmq.Context to talk to all my kernels # See also: MultiKernelManager.shared_context # c.AsyncMappingKernelManager.shared_context = True ## Message to print when allow_tracebacks is False, and an exception occurs # See also: MappingKernelManager.traceback_replacement_message # c.AsyncMappingKernelManager.traceback_replacement_message = 'An exception occurred at runtime, which is not shown due to security reasons.' ## Whether to make kernels available before the process has started. The # See also: AsyncMultiKernelManager.use_pending_kernels # c.AsyncMappingKernelManager.use_pending_kernels = False #------------------------------------------------------------------------------ # 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. ## Allow access to hidden files # Default: False # c.ContentsManager.allow_hidden = False # Default: None # c.ContentsManager.checkpoints = None # Default: 'jupyter_server.services.contents.checkpoints.Checkpoints' # c.ContentsManager.checkpoints_class = 'jupyter_server.services.contents.checkpoints.Checkpoints' # Default: {} # c.ContentsManager.checkpoints_kwargs = {} # Default: None # c.ContentsManager.event_logger = None ## handler class to use when serving raw file requests. # # Default is a fallback that talks to the ContentsManager API, # which may be inefficient, especially for large files. # # Local files-based ContentsManagers can use a StaticFileHandler subclass, # which will be much more efficient. # # Access to these files should be Authenticated. # Default: 'jupyter_server.files.handlers.FilesHandler' # c.ContentsManager.files_handler_class = 'jupyter_server.files.handlers.FilesHandler' ## Extra parameters to pass to files_handler_class. # # For example, StaticFileHandlers generally expect a `path` argument # specifying the root directory from which to serve files. # Default: {} # c.ContentsManager.files_handler_params = {} ## Glob patterns to hide in file and directory listings. # Default: ['__pycache__', '*.pyc', '*.pyo', '.DS_Store', '*.so', '*.dylib', '*~'] # c.ContentsManager.hide_globs = ['__pycache__', '*.pyc', '*.pyo', '.DS_Store', '*.so', '*.dylib', '*~'] ## 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 # Default: None # c.ContentsManager.post_save_hook = None ## 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 # Default: None # c.ContentsManager.pre_save_hook = None ## Preferred starting directory to use for notebooks. This is an API path (`/` # separated, relative to root dir) # Default: '' # c.ContentsManager.preferred_dir = '' # Default: '/' # c.ContentsManager.root_dir = '/' ## The base name used when creating untitled directories. # Default: 'Untitled Folder' # c.ContentsManager.untitled_directory = 'Untitled Folder' ## The base name used when creating untitled files. # Default: 'untitled' # c.ContentsManager.untitled_file = 'untitled' ## The base name used when creating untitled notebooks. # Default: 'Untitled' # c.ContentsManager.untitled_notebook = 'Untitled' #------------------------------------------------------------------------------ # FileManagerMixin(LoggingConfigurable, Configurable) configuration #------------------------------------------------------------------------------ ## Mixin for ContentsAPI classes that interact with the filesystem. # # Provides facilities for reading, writing, and copying 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 ## Hash algorithm to use for file content, support by hashlib # Choices: any of ['sha256', 'sha3_224', 'sha3_384', 'sha3_512', 'sha1', 'sha3_256', 'blake2s', 'shake_256', 'sm3', 'sha512_256', 'md5-sha1', 'ripemd160', 'sha512_224', 'whirlpool', 'shake_128', 'sha224', 'sha512', 'md5', 'md4', 'blake2b', 'sha384'] # Default: 'sha256' # c.FileManagerMixin.hash_algorithm = 'sha256' ## By default notebooks are saved on disk on a temporary file and then if successfully written, it replaces the old ones. # This procedure, namely 'atomic_writing', causes some bugs on file system without 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 ) # Default: True # c.FileManagerMixin.use_atomic_writing = True #------------------------------------------------------------------------------ # FileContentsManager(FileManagerMixin, ContentsManager) configuration #------------------------------------------------------------------------------ ## A file contents manager. ## Allow access to hidden files # See also: ContentsManager.allow_hidden # c.FileContentsManager.allow_hidden = False ## If True, deleting a non-empty directory will always be allowed. # WARNING this may result in files being permanently removed; e.g. on Windows, # if the data size is too big for the trash/recycle bin the directory will be permanently # deleted. If False (default), the non-empty directory will be sent to the trash only # if safe. And if ``delete_to_trash`` is True, the directory won't be deleted. # Default: False # c.FileContentsManager.always_delete_dir = False # See also: ContentsManager.checkpoints # c.FileContentsManager.checkpoints = None # See also: ContentsManager.checkpoints_class # c.FileContentsManager.checkpoints_class = 'jupyter_server.services.contents.checkpoints.Checkpoints' # See also: ContentsManager.checkpoints_kwargs # c.FileContentsManager.checkpoints_kwargs = {} ## If True (default), deleting files will send them to the # platform's trash/recycle bin, where they can be recovered. If False, # deleting files really deletes them. # Default: True # c.FileContentsManager.delete_to_trash = True # See also: ContentsManager.event_logger # c.FileContentsManager.event_logger = None ## handler class to use when serving raw file requests. # See also: ContentsManager.files_handler_class # c.FileContentsManager.files_handler_class = 'jupyter_server.files.handlers.FilesHandler' ## Extra parameters to pass to files_handler_class. # See also: ContentsManager.files_handler_params # c.FileContentsManager.files_handler_params = {} ## Hash algorithm to use for file content, support by hashlib # See also: FileManagerMixin.hash_algorithm # c.FileContentsManager.hash_algorithm = 'sha256' ## # See also: ContentsManager.hide_globs # c.FileContentsManager.hide_globs = ['__pycache__', '*.pyc', '*.pyo', '.DS_Store', '*.so', '*.dylib', '*~'] ## The max folder size that can be copied # Default: 500 # c.FileContentsManager.max_copy_folder_size_mb = 500 ## Python callable or importstring thereof # See also: ContentsManager.post_save_hook # c.FileContentsManager.post_save_hook = None ## Python callable or importstring thereof # See also: ContentsManager.pre_save_hook # c.FileContentsManager.pre_save_hook = None ## Preferred starting directory to use for notebooks. This is an API path (`/` # separated, relative to root dir) # See also: ContentsManager.preferred_dir # c.FileContentsManager.preferred_dir = '' # Default: '' # c.FileContentsManager.root_dir = '' ## The base name used when creating untitled directories. # See also: ContentsManager.untitled_directory # c.FileContentsManager.untitled_directory = 'Untitled Folder' ## The base name used when creating untitled files. # See also: ContentsManager.untitled_file # c.FileContentsManager.untitled_file = 'untitled' ## The base name used when creating untitled notebooks. # See also: ContentsManager.untitled_notebook # c.FileContentsManager.untitled_notebook = 'Untitled' ## By default notebooks are saved on disk on a temporary file and then if # successfully written, it replaces the old ones. # See also: FileManagerMixin.use_atomic_writing # c.FileContentsManager.use_atomic_writing = True #------------------------------------------------------------------------------ # AsyncContentsManager(ContentsManager) configuration #------------------------------------------------------------------------------ ## Base class for serving files and directories asynchronously. ## Allow access to hidden files # See also: ContentsManager.allow_hidden # c.AsyncContentsManager.allow_hidden = False # Default: None # c.AsyncContentsManager.checkpoints = None # Default: 'jupyter_server.services.contents.checkpoints.AsyncCheckpoints' # c.AsyncContentsManager.checkpoints_class = 'jupyter_server.services.contents.checkpoints.AsyncCheckpoints' # Default: {} # c.AsyncContentsManager.checkpoints_kwargs = {} # See also: ContentsManager.event_logger # c.AsyncContentsManager.event_logger = None ## handler class to use when serving raw file requests. # See also: ContentsManager.files_handler_class # c.AsyncContentsManager.files_handler_class = 'jupyter_server.files.handlers.FilesHandler' ## Extra parameters to pass to files_handler_class. # See also: ContentsManager.files_handler_params # c.AsyncContentsManager.files_handler_params = {} ## # See also: ContentsManager.hide_globs # c.AsyncContentsManager.hide_globs = ['__pycache__', '*.pyc', '*.pyo', '.DS_Store', '*.so', '*.dylib', '*~'] ## Python callable or importstring thereof # See also: ContentsManager.post_save_hook # c.AsyncContentsManager.post_save_hook = None ## Python callable or importstring thereof # See also: ContentsManager.pre_save_hook # c.AsyncContentsManager.pre_save_hook = None ## Preferred starting directory to use for notebooks. This is an API path (`/` # separated, relative to root dir) # See also: ContentsManager.preferred_dir # c.AsyncContentsManager.preferred_dir = '' # See also: ContentsManager.root_dir # c.AsyncContentsManager.root_dir = '/' ## The base name used when creating untitled directories. # See also: ContentsManager.untitled_directory # c.AsyncContentsManager.untitled_directory = 'Untitled Folder' ## The base name used when creating untitled files. # See also: ContentsManager.untitled_file # c.AsyncContentsManager.untitled_file = 'untitled' ## The base name used when creating untitled notebooks. # See also: ContentsManager.untitled_notebook # c.AsyncContentsManager.untitled_notebook = 'Untitled' #------------------------------------------------------------------------------ # AsyncFileManagerMixin(FileManagerMixin) configuration #------------------------------------------------------------------------------ ## Mixin for ContentsAPI classes that interact with the filesystem # asynchronously. ## Hash algorithm to use for file content, support by hashlib # See also: FileManagerMixin.hash_algorithm # c.AsyncFileManagerMixin.hash_algorithm = 'sha256' ## By default notebooks are saved on disk on a temporary file and then if # successfully written, it replaces the old ones. # See also: FileManagerMixin.use_atomic_writing # c.AsyncFileManagerMixin.use_atomic_writing = True #------------------------------------------------------------------------------ # AsyncFileContentsManager(FileContentsManager, AsyncFileManagerMixin, AsyncContentsManager) configuration #------------------------------------------------------------------------------ ## An async file contents manager. ## Allow access to hidden files # See also: ContentsManager.allow_hidden # c.AsyncFileContentsManager.allow_hidden = False ## If True, deleting a non-empty directory will always be allowed. # See also: FileContentsManager.always_delete_dir # c.AsyncFileContentsManager.always_delete_dir = False # See also: AsyncContentsManager.checkpoints # c.AsyncFileContentsManager.checkpoints = None # See also: AsyncContentsManager.checkpoints_class # c.AsyncFileContentsManager.checkpoints_class = 'jupyter_server.services.contents.checkpoints.AsyncCheckpoints' # See also: AsyncContentsManager.checkpoints_kwargs # c.AsyncFileContentsManager.checkpoints_kwargs = {} ## If True (default), deleting files will send them to the # See also: FileContentsManager.delete_to_trash # c.AsyncFileContentsManager.delete_to_trash = True # See also: ContentsManager.event_logger # c.AsyncFileContentsManager.event_logger = None ## handler class to use when serving raw file requests. # See also: ContentsManager.files_handler_class # c.AsyncFileContentsManager.files_handler_class = 'jupyter_server.files.handlers.FilesHandler' ## Extra parameters to pass to files_handler_class. # See also: ContentsManager.files_handler_params # c.AsyncFileContentsManager.files_handler_params = {} ## Hash algorithm to use for file content, support by hashlib # See also: FileManagerMixin.hash_algorithm # c.AsyncFileContentsManager.hash_algorithm = 'sha256' ## # See also: ContentsManager.hide_globs # c.AsyncFileContentsManager.hide_globs = ['__pycache__', '*.pyc', '*.pyo', '.DS_Store', '*.so', '*.dylib', '*~'] ## The max folder size that can be copied # See also: FileContentsManager.max_copy_folder_size_mb # c.AsyncFileContentsManager.max_copy_folder_size_mb = 500 ## Python callable or importstring thereof # See also: ContentsManager.post_save_hook # c.AsyncFileContentsManager.post_save_hook = None ## Python callable or importstring thereof # See also: ContentsManager.pre_save_hook # c.AsyncFileContentsManager.pre_save_hook = None ## Preferred starting directory to use for notebooks. This is an API path (`/` # separated, relative to root dir) # See also: ContentsManager.preferred_dir # c.AsyncFileContentsManager.preferred_dir = '' # See also: FileContentsManager.root_dir # c.AsyncFileContentsManager.root_dir = '' ## The base name used when creating untitled directories. # See also: ContentsManager.untitled_directory # c.AsyncFileContentsManager.untitled_directory = 'Untitled Folder' ## The base name used when creating untitled files. # See also: ContentsManager.untitled_file # c.AsyncFileContentsManager.untitled_file = 'untitled' ## The base name used when creating untitled notebooks. # See also: ContentsManager.untitled_notebook # c.AsyncFileContentsManager.untitled_notebook = 'Untitled' ## By default notebooks are saved on disk on a temporary file and then if # successfully written, it replaces the old ones. # See also: FileManagerMixin.use_atomic_writing # c.AsyncFileContentsManager.use_atomic_writing = True #------------------------------------------------------------------------------ # NotebookNotary(LoggingConfigurable) configuration #------------------------------------------------------------------------------ ## A class for computing and verifying notebook signatures. ## The hashing algorithm used to sign notebooks. # Choices: any of ['sha256', 'sha224', 'sha512', 'sha3_256', 'blake2s', 'sha3_224', 'sha3_384', 'md5', 'sha3_512', 'sha384', 'blake2b', 'sha1'] # Default: 'sha256' # c.NotebookNotary.algorithm = 'sha256' ## The storage directory for notary secret and database. # Default: '' # c.NotebookNotary.data_dir = '' ## 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. # Default: '' # c.NotebookNotary.db_file = '' ## The secret key with which notebooks are signed. # Default: b'' # c.NotebookNotary.secret = b'' ## The file where the secret key is stored. # Default: '' # c.NotebookNotary.secret_file = '' ## A callable returning the storage backend for notebook signatures. # The default uses an SQLite database. # Default: traitlets.Undefined # c.NotebookNotary.store_factory = traitlets.Undefined #------------------------------------------------------------------------------ # GatewayMappingKernelManager(AsyncMappingKernelManager) configuration #------------------------------------------------------------------------------ ## Kernel manager that supports remote kernels hosted by Jupyter Kernel or # Enterprise Gateway. ## Whether to send tracebacks to clients on exceptions. # See also: MappingKernelManager.allow_tracebacks # c.GatewayMappingKernelManager.allow_tracebacks = True ## White list of allowed kernel message types. # See also: MappingKernelManager.allowed_message_types # c.GatewayMappingKernelManager.allowed_message_types = [] ## Whether messages from kernels whose frontends have disconnected should be # buffered in-memory. # See also: MappingKernelManager.buffer_offline_messages # c.GatewayMappingKernelManager.buffer_offline_messages = True ## Whether to consider culling kernels which are busy. # See also: MappingKernelManager.cull_busy # c.GatewayMappingKernelManager.cull_busy = False ## Whether to consider culling kernels which have one or more connections. # See also: MappingKernelManager.cull_connected # c.GatewayMappingKernelManager.cull_connected = False ## Timeout (in seconds) after which a kernel is considered idle and ready to be # culled. # See also: MappingKernelManager.cull_idle_timeout # c.GatewayMappingKernelManager.cull_idle_timeout = 0 ## The interval (in seconds) on which to check for idle kernels exceeding the # cull timeout value. # See also: MappingKernelManager.cull_interval # c.GatewayMappingKernelManager.cull_interval = 300 ## The name of the default kernel to start # See also: MultiKernelManager.default_kernel_name # c.GatewayMappingKernelManager.default_kernel_name = 'python3' ## Timeout for giving up on a kernel (in seconds). # See also: MappingKernelManager.kernel_info_timeout # c.GatewayMappingKernelManager.kernel_info_timeout = 60 ## The kernel manager class. This is configurable to allow # See also: AsyncMultiKernelManager.kernel_manager_class # c.GatewayMappingKernelManager.kernel_manager_class = 'jupyter_client.ioloop.AsyncIOLoopKernelManager' # See also: MappingKernelManager.root_dir # c.GatewayMappingKernelManager.root_dir = '' ## Share a single zmq.Context to talk to all my kernels # See also: MultiKernelManager.shared_context # c.GatewayMappingKernelManager.shared_context = True ## Message to print when allow_tracebacks is False, and an exception occurs # See also: MappingKernelManager.traceback_replacement_message # c.GatewayMappingKernelManager.traceback_replacement_message = 'An exception occurred at runtime, which is not shown due to security reasons.' ## Whether to make kernels available before the process has started. The # See also: AsyncMultiKernelManager.use_pending_kernels # c.GatewayMappingKernelManager.use_pending_kernels = False #------------------------------------------------------------------------------ # GatewayKernelSpecManager(KernelSpecManager) configuration #------------------------------------------------------------------------------ ## A gateway kernel spec manager. ## List of allowed kernel names. # See also: KernelSpecManager.allowed_kernelspecs # c.GatewayKernelSpecManager.allowed_kernelspecs = set() ## If there is no Python kernelspec registered and the IPython # See also: KernelSpecManager.ensure_native_kernel # c.GatewayKernelSpecManager.ensure_native_kernel = True ## The kernel spec class. This is configurable to allow # See also: KernelSpecManager.kernel_spec_class # c.GatewayKernelSpecManager.kernel_spec_class = 'jupyter_client.kernelspec.KernelSpec' ## Deprecated, use `KernelSpecManager.allowed_kernelspecs` # See also: KernelSpecManager.whitelist # c.GatewayKernelSpecManager.whitelist = set() #------------------------------------------------------------------------------ # SessionManager(LoggingConfigurable) configuration #------------------------------------------------------------------------------ ## A session manager. ## The filesystem path to SQLite Database file (e.g. # /path/to/session_database.db). By default, the session database is stored in- # memory (i.e. `:memory:` setting from sqlite3) and does not persist when the # current Jupyter Server shuts down. # Default: ':memory:' # c.SessionManager.database_filepath = ':memory:' #------------------------------------------------------------------------------ # GatewaySessionManager(SessionManager) configuration #------------------------------------------------------------------------------ ## A gateway session manager. ## The filesystem path to SQLite Database file (e.g. # /path/to/session_database.db). By default, the session database is stored in- # memory (i.e. `:memory:` setting from sqlite3) and does not persist when the # current Jupyter Server shuts down. # See also: SessionManager.database_filepath # c.GatewaySessionManager.database_filepath = ':memory:' #------------------------------------------------------------------------------ # BaseKernelWebsocketConnection(LoggingConfigurable) configuration #------------------------------------------------------------------------------ ## A configurable base class for connecting Kernel WebSockets to ZMQ sockets. ## Preferred kernel message protocol over websocket to use (default: None). If an # empty string is passed, select the legacy protocol. If None, the selected # protocol will depend on what the front-end supports (usually the most recent # protocol supported by the back-end and the front-end). # Default: None # c.BaseKernelWebsocketConnection.kernel_ws_protocol = None # Default: None # c.BaseKernelWebsocketConnection.session = None #------------------------------------------------------------------------------ # GatewayWebSocketConnection(BaseKernelWebsocketConnection) configuration #------------------------------------------------------------------------------ ## Web socket connection that proxies to a kernel/enterprise gateway. # Default: '' # c.GatewayWebSocketConnection.kernel_ws_protocol = '' # See also: BaseKernelWebsocketConnection.session # c.GatewayWebSocketConnection.session = None #------------------------------------------------------------------------------ # GatewayClient(SingletonConfigurable) configuration #------------------------------------------------------------------------------ ## This class manages the configuration. It's its own singleton class so # that we can share these values across all objects. It also contains some # options. # helper methods to build request arguments out of the various config ## Accept and manage cookies sent by the service side. This is often useful # for load balancers to decide which backend node to use. # (JUPYTER_GATEWAY_ACCEPT_COOKIES env var) # Default: False # c.GatewayClient.accept_cookies = False ## A comma-separated list of environment variable names that will be included, # along with their values, in the kernel startup request. The corresponding # `client_envs` configuration value must also be set on the Gateway server - # since that configuration value indicates which environmental values to make # available to the kernel. (JUPYTER_GATEWAY_ALLOWED_ENVS env var) # Default: '' # c.GatewayClient.allowed_envs = '' ## The authorization header's key name (typically 'Authorization') used in the # HTTP headers. The header will be formatted as:: # # {'{auth_header_key}': '{auth_scheme} {auth_token}'} # # If the authorization header key takes a single value, `auth_scheme` should be # set to None and 'auth_token' should be configured to use the appropriate # value. # # (JUPYTER_GATEWAY_AUTH_HEADER_KEY env var) # Default: '' # c.GatewayClient.auth_header_key = '' ## The auth scheme, added as a prefix to the authorization token used in the HTTP # headers. (JUPYTER_GATEWAY_AUTH_SCHEME env var) # Default: '' # c.GatewayClient.auth_scheme = '' ## The authorization token used in the HTTP headers. The header will be formatted # as:: # # {'{auth_header_key}': '{auth_scheme} {auth_token}'} # # (JUPYTER_GATEWAY_AUTH_TOKEN env var) # Default: None # c.GatewayClient.auth_token = None ## The filename of CA certificates or None to use defaults. # (JUPYTER_GATEWAY_CA_CERTS env var) # Default: None # c.GatewayClient.ca_certs = None ## The filename for client SSL certificate, if any. (JUPYTER_GATEWAY_CLIENT_CERT # env var) # Default: None # c.GatewayClient.client_cert = None ## The filename for client SSL key, if any. (JUPYTER_GATEWAY_CLIENT_KEY env var) # Default: None # c.GatewayClient.client_key = None ## The time allowed for HTTP connection establishment with the Gateway server. # (JUPYTER_GATEWAY_CONNECT_TIMEOUT env var) # Default: 40.0 # c.GatewayClient.connect_timeout = 40.0 ## Deprecated, use `GatewayClient.allowed_envs` # Default: '' # c.GatewayClient.env_whitelist = '' # Default: None # c.GatewayClient.event_logger = None ## The time allowed for HTTP reconnection with the Gateway server for the first # time. Next will be JUPYTER_GATEWAY_RETRY_INTERVAL multiplied by two in factor # of numbers of retries but less than JUPYTER_GATEWAY_RETRY_INTERVAL_MAX. # (JUPYTER_GATEWAY_RETRY_INTERVAL env var) # Default: 1.0 # c.GatewayClient.gateway_retry_interval = 1.0 ## The maximum time allowed for HTTP reconnection retry with the Gateway server. # (JUPYTER_GATEWAY_RETRY_INTERVAL_MAX env var) # Default: 30.0 # c.GatewayClient.gateway_retry_interval_max = 30.0 ## The maximum retries allowed for HTTP reconnection with the Gateway server. # (JUPYTER_GATEWAY_RETRY_MAX env var) # Default: 5 # c.GatewayClient.gateway_retry_max = 5 ## The class to use for Gateway token renewal. # (JUPYTER_GATEWAY_TOKEN_RENEWER_CLASS env var) # Default: 'jupyter_server.gateway.gateway_client.GatewayTokenRenewerBase' # c.GatewayClient.gateway_token_renewer_class = 'jupyter_server.gateway.gateway_client.GatewayTokenRenewerBase' ## Additional HTTP headers to pass on the request. This value will be converted to a dict. # (JUPYTER_GATEWAY_HEADERS env var) # Default: '{}' # c.GatewayClient.headers = '{}' ## The password for HTTP authentication. (JUPYTER_GATEWAY_HTTP_PWD env var) # Default: None # c.GatewayClient.http_pwd = None ## The username for HTTP authentication. (JUPYTER_GATEWAY_HTTP_USER env var) # Default: None # c.GatewayClient.http_user = None ## The gateway API endpoint for accessing kernel resources # (JUPYTER_GATEWAY_KERNELS_ENDPOINT env var) # Default: '/api/kernels' # c.GatewayClient.kernels_endpoint = '/api/kernels' ## The gateway API endpoint for accessing kernelspecs # (JUPYTER_GATEWAY_KERNELSPECS_ENDPOINT env var) # Default: '/api/kernelspecs' # c.GatewayClient.kernelspecs_endpoint = '/api/kernelspecs' ## The gateway endpoint for accessing kernelspecs resources # (JUPYTER_GATEWAY_KERNELSPECS_RESOURCE_ENDPOINT env var) # Default: '/kernelspecs' # c.GatewayClient.kernelspecs_resource_endpoint = '/kernelspecs' ## Timeout pad to be ensured between KERNEL_LAUNCH_TIMEOUT and request_timeout # such that request_timeout >= KERNEL_LAUNCH_TIMEOUT + launch_timeout_pad. # (JUPYTER_GATEWAY_LAUNCH_TIMEOUT_PAD env var) # Default: 2.0 # c.GatewayClient.launch_timeout_pad = 2.0 ## The time allowed for HTTP request completion. (JUPYTER_GATEWAY_REQUEST_TIMEOUT # env var) # Default: 42.0 # c.GatewayClient.request_timeout = 42.0 ## The url of the Kernel or Enterprise Gateway server where kernel specifications # are defined and kernel management takes place. If defined, this Notebook # server acts as a proxy for all kernel management and kernel specification # retrieval. (JUPYTER_GATEWAY_URL env var) # Default: None # c.GatewayClient.url = None ## For HTTPS requests, determines if server's certificate should be validated or # not. (JUPYTER_GATEWAY_VALIDATE_CERT env var) # Default: True # c.GatewayClient.validate_cert = True ## The websocket url of the Kernel or Enterprise Gateway server. If not # provided, this value will correspond to the value of the Gateway url with 'ws' # in place of 'http'. (JUPYTER_GATEWAY_WS_URL env var) # Default: None # c.GatewayClient.ws_url = None #------------------------------------------------------------------------------ # EventLogger(LoggingConfigurable) configuration #------------------------------------------------------------------------------ ## An Event logger for emitting structured events. # # Event schemas must be registered with the EventLogger using the # `register_schema` or `register_schema_file` methods. Every schema will be # validated against Jupyter Event's metaschema. ## A list of logging.Handler instances to send events to. # # When set to None (the default), all events are discarded. # Default: None # c.EventLogger.handlers = None #------------------------------------------------------------------------------ # ZMQChannelsWebsocketConnection(BaseKernelWebsocketConnection) configuration #------------------------------------------------------------------------------ ## A Jupyter Server Websocket Connection ## (bytes/sec) # Maximum rate at which stream output can be sent on iopub before they are # limited. # Default: 1000000 # c.ZMQChannelsWebsocketConnection.iopub_data_rate_limit = 1000000 ## (msgs/sec) # Maximum rate at which messages can be sent on iopub before they are # limited. # Default: 1000 # c.ZMQChannelsWebsocketConnection.iopub_msg_rate_limit = 1000 ## Preferred kernel message protocol over websocket to use (default: None). If an # empty string is passed, select the legacy protocol. If None, the selected # protocol will depend on what the front-end supports (usually the most recent # protocol supported by the back-end and the front-end). # See also: BaseKernelWebsocketConnection.kernel_ws_protocol # c.ZMQChannelsWebsocketConnection.kernel_ws_protocol = None ## Whether to limit the rate of IOPub messages (default: True). If True, use # iopub_msg_rate_limit, iopub_data_rate_limit and/or rate_limit_window to tune # the rate. # Default: True # c.ZMQChannelsWebsocketConnection.limit_rate = True ## (sec) Time window used to # check the message and data rate limits. # Default: 3 # c.ZMQChannelsWebsocketConnection.rate_limit_window = 3 # See also: BaseKernelWebsocketConnection.session # c.ZMQChannelsWebsocketConnection.session = None