Created
March 6, 2015 09:09
-
-
Save yuvipanda/08e06376ddb98f21a8c4 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Configuration file for jupyterhub. | |
c = get_config() | |
#------------------------------------------------------------------------------ | |
# JupyterHub configuration | |
#------------------------------------------------------------------------------ | |
# An Application for starting a Multi-User Jupyter Notebook server. | |
# JupyterHub will inherit config from: Application | |
# Interval (in seconds) at which to check if the proxy is running. | |
# c.JupyterHub.proxy_check_interval = 30 | |
# Answer yes to any questions (e.g. confirm overwrite) | |
# c.JupyterHub.answer_yes = False | |
# The public facing ip of the proxy | |
c.JupyterHub.ip = '' | |
# The class to use for spawning single-user servers. | |
# | |
# Should be a subclass of Spawner. | |
# c.JupyterHub.spawner_class = <class 'jupyterhub.spawner.LocalProcessSpawner'> | |
c.JupyterHub.spawner_class = 'dockerspawner.DockerSpawner' | |
# The port for this process | |
c.JupyterHub.hub_port = 8081 | |
# log all database transactions. This has A LOT of output | |
# c.JupyterHub.debug_db = False | |
# The ip for this process | |
c.JupyterHub.hub_ip = '10.68.17.169' | |
# Include any kwargs to pass to the database connection. See | |
# sqlalchemy.create_engine for details. | |
# c.JupyterHub.db_kwargs = {} | |
# Whether to shutdown single-user servers when the Hub shuts down. | |
# | |
# Disable if you want to be able to teardown the Hub while leaving the single- | |
# user servers running. | |
# | |
# If both this and cleanup_proxy are False, sending SIGINT to the Hub will only | |
# shutdown the Hub, leaving everything else running. | |
# | |
# The Hub should be able to resume from database state. | |
# c.JupyterHub.cleanup_servers = True | |
# Set the log level by value or name. | |
# c.JupyterHub.log_level = 30 | |
# File to write PID Useful for daemonizing jupyterhub. | |
# c.JupyterHub.pid_file = '' | |
# The command to start the http proxy. | |
# | |
# Only override if configurable-http-proxy is not on your PATH | |
# c.JupyterHub.proxy_cmd = 'configurable-http-proxy' | |
# Extra log handlers to set on JupyterHub logger | |
# c.JupyterHub.extra_log_handlers = [] | |
# The public facing port of the proxy | |
# c.JupyterHub.port = 8000 | |
# The prefix for the hub server. Must not be '/' | |
# c.JupyterHub.hub_prefix = '/hub/' | |
# The location of jupyterhub data files (e.g. /usr/local/share/jupyter/hub) | |
# c.JupyterHub.data_files_path = '/srv/jupyterhub/share/jupyter/hub' | |
# The base URL of the entire application | |
# c.JupyterHub.base_url = '/' | |
# | |
# c.JupyterHub.tornado_settings = {} | |
# Path to SSL certificate file for the public facing interface of the proxy | |
# | |
# Use with ssl_key | |
# c.JupyterHub.ssl_cert = '' | |
# set of usernames of admin users | |
# | |
# If unspecified, only the user that launches the server will be admin. | |
# c.JupyterHub.admin_users = set() | |
# Path to SSL key file for the public facing interface of the proxy | |
# | |
# Use with ssl_cert | |
# c.JupyterHub.ssl_key = '' | |
# The Logging format template | |
# c.JupyterHub.log_format = '[%(name)s]%(highlevel)s %(message)s' | |
# show debug output in configurable-http-proxy | |
# c.JupyterHub.debug_proxy = False | |
# File in which to store the cookie secret. | |
# c.JupyterHub.cookie_secret_file = 'jupyterhub_cookie_secret' | |
# Grant admin users permission to access single-user servers. | |
# | |
# Users should be properly informed if this is enabled. | |
# c.JupyterHub.admin_access = False | |
# The port for the proxy API handlers | |
# c.JupyterHub.proxy_api_port = 0 | |
# Interval (in seconds) at which to update last-activity timestamps. | |
# c.JupyterHub.last_activity_interval = 300 | |
# The Proxy Auth token. | |
# | |
# Loaded from the CONFIGPROXY_AUTH_TOKEN env variable by default. | |
# c.JupyterHub.proxy_auth_token = '' | |
# The config file to load | |
# c.JupyterHub.config_file = 'jupyterhub_config.py' | |
# The cookie secret to use to encrypt cookies. | |
# | |
# Loaded from the JPY_COOKIE_SECRET env variable by default. | |
# c.JupyterHub.cookie_secret = b'' | |
# Whether to shutdown the proxy when the Hub shuts down. | |
# | |
# Disable if you want to be able to teardown the Hub while leaving the proxy | |
# running. | |
# | |
# Only valid if the proxy was starting by the Hub process. | |
# | |
# If both this and cleanup_servers are False, sending SIGINT to the Hub will | |
# only shutdown the Hub, leaving everything else running. | |
# | |
# The Hub should be able to resume from database state. | |
# c.JupyterHub.cleanup_proxy = True | |
# Class for authenticating users. | |
# | |
# This should be a class with the following form: | |
# | |
# - constructor takes one kwarg: `config`, the IPython config object. | |
# | |
# - is a tornado.gen.coroutine | |
# - returns username on success, None on failure | |
# - takes two arguments: (handler, data), | |
# where `handler` is the calling web.RequestHandler, | |
# and `data` is the POST form data from the login page. | |
c.JupyterHub.authenticator_class = 'oauthenticator.GitHubOAuthenticator' | |
c.GitHubOAuthenticator.oauth_callback_url = 'https://jupyter.wmflabs.org/hub/oauth_callback' | |
c.GitHubOAuthenticator.github_client_id = '' | |
c.GitHubOAuthenticator.github_client_secret = '' | |
# c.JupyterHub.authenticator_class = <class 'jupyterhub.auth.PAMAuthenticator'> | |
# The ip for the proxy API handlers | |
c.JupyterHub.proxy_api_ip = '10.68.17.169' | |
# Supply extra arguments that will be passed to Jinja environment. | |
# c.JupyterHub.jinja_environment_options = {} | |
# Generate default config file | |
# c.JupyterHub.generate_config = False | |
# Purge and reset the database. | |
# c.JupyterHub.reset_db = False | |
# The date format used by logging formatters for %(asctime)s | |
# c.JupyterHub.log_datefmt = '%Y-%m-%d %H:%M:%S' | |
# url for the database. e.g. `sqlite:///jupyterhub.sqlite` | |
# c.JupyterHub.db_url = 'sqlite:///jupyterhub.sqlite' | |
# Set a logging.FileHandler on this file. | |
# c.JupyterHub.extra_log_file = '' | |
#------------------------------------------------------------------------------ | |
# Spawner configuration | |
#------------------------------------------------------------------------------ | |
# Base class for spawning single-user notebook servers. | |
# | |
# Subclass this, and override the following methods: | |
# | |
# - load_state - get_state - start - stop - poll | |
# The command used for starting notebooks. | |
# c.Spawner.cmd = ['jupyterhub-singleuser'] | |
# Timeout (in seconds) before giving up on a spawned HTTP server | |
# | |
# Once a server has successfully been spawned, this is the amount of time we | |
# wait before assuming that the server is unable to accept connections. | |
# c.Spawner.http_timeout = 10 | |
# Extra arguments to be passed to the single-user server | |
# c.Spawner.args = [] | |
# Timeout (in seconds) before giving up on the spawner. | |
# | |
# This is the timeout for start to return, not the timeout for the server to | |
# respond. Callers of spawner.start will assume that startup has failed if it | |
# takes longer than this. start should return when the server process is started | |
# and its location is known. | |
# c.Spawner.start_timeout = 60 | |
# Interval (in seconds) on which to poll the spawner. | |
# c.Spawner.poll_interval = 30 | |
# The IP address (or hostname) the single-user server should listen on | |
# c.Spawner.ip = 'localhost' | |
# The notebook directory for the single-user server | |
# | |
# `~` will be expanded to the user's home directory | |
# c.Spawner.notebook_dir = '' | |
# Enable debug-logging of the single-user server | |
c.Spawner.debug = True | |
# Whitelist of environment variables for the subprocess to inherit | |
# c.Spawner.env_keep = ['PATH', 'PYTHONPATH', 'CONDA_ROOT', 'CONDA_DEFAULT_ENV', 'VIRTUAL_ENV', 'LANG', 'LC_ALL'] | |
#------------------------------------------------------------------------------ | |
# LocalProcessSpawner configuration | |
#------------------------------------------------------------------------------ | |
# A Spawner that just uses Popen to start local processes. | |
# LocalProcessSpawner will inherit config from: Spawner | |
# Seconds to wait for process to halt after SIGKILL before giving up | |
# c.LocalProcessSpawner.KILL_TIMEOUT = 5 | |
# Timeout (in seconds) before giving up on the spawner. | |
# | |
# This is the timeout for start to return, not the timeout for the server to | |
# respond. Callers of spawner.start will assume that startup has failed if it | |
# takes longer than this. start should return when the server process is started | |
# and its location is known. | |
# c.LocalProcessSpawner.start_timeout = 60 | |
# Interval (in seconds) on which to poll the spawner. | |
# c.LocalProcessSpawner.poll_interval = 30 | |
# The IP address (or hostname) the single-user server should listen on | |
# c.LocalProcessSpawner.ip = 'localhost' | |
# Enable debug-logging of the single-user server | |
# c.LocalProcessSpawner.debug = False | |
# Seconds to wait for process to halt after SIGINT before proceeding to SIGTERM | |
# c.LocalProcessSpawner.INTERRUPT_TIMEOUT = 10 | |
# The command used for starting notebooks. | |
# c.LocalProcessSpawner.cmd = ['jupyterhub-singleuser'] | |
# Timeout (in seconds) before giving up on a spawned HTTP server | |
# | |
# Once a server has successfully been spawned, this is the amount of time we | |
# wait before assuming that the server is unable to accept connections. | |
# c.LocalProcessSpawner.http_timeout = 10 | |
# Extra arguments to be passed to the single-user server | |
# c.LocalProcessSpawner.args = [] | |
# The notebook directory for the single-user server | |
# | |
# `~` will be expanded to the user's home directory | |
# c.LocalProcessSpawner.notebook_dir = '' | |
# Whitelist of environment variables for the subprocess to inherit | |
# c.LocalProcessSpawner.env_keep = ['PATH', 'PYTHONPATH', 'CONDA_ROOT', 'CONDA_DEFAULT_ENV', 'VIRTUAL_ENV', 'LANG', 'LC_ALL'] | |
# Seconds to wait for process to halt after SIGTERM before proceeding to SIGKILL | |
# c.LocalProcessSpawner.TERM_TIMEOUT = 5 | |
#------------------------------------------------------------------------------ | |
# Authenticator configuration | |
#------------------------------------------------------------------------------ | |
# A class for authentication. | |
# | |
# The API is one method, `authenticate`, a tornado gen.coroutine. | |
# Username whitelist. | |
# | |
# Use this to restrict which users can login. If empty, allow any user to | |
# attempt login. | |
# c.Authenticator.whitelist = set() | |
#------------------------------------------------------------------------------ | |
# PAMAuthenticator configuration | |
#------------------------------------------------------------------------------ | |
# Authenticate local *ix users with PAM | |
# PAMAuthenticator will inherit config from: LocalAuthenticator, Authenticator | |
# Username whitelist. | |
# | |
# Use this to restrict which users can login. If empty, allow any user to | |
# attempt login. | |
# c.PAMAuthenticator.whitelist = set() | |
# If a user is added that doesn't exist on the system, should I try to create | |
# the system user? | |
# c.PAMAuthenticator.create_system_users = False | |
# The encoding to use for PAM | |
# c.PAMAuthenticator.encoding = 'utf8' | |
# The PAM service to use for authentication. | |
# c.PAMAuthenticator.service = 'login' |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment