forked from twiecki/pydata_docker_jupyterhub
-
Notifications
You must be signed in to change notification settings - Fork 0
/
jupyterhub_config.py
234 lines (169 loc) · 7.31 KB
/
jupyterhub_config.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
# 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
# Include any kwargs to pass to the database connection. See
# sqlalchemy.create_engine for details.
# c.JupyterHub.db_kwargs = {}
# The base URL of the entire application
# c.JupyterHub.base_url = '/'
# 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 = <class 'jupyterhub.auth.PAMAuthenticator'>
# The config file to load
# c.JupyterHub.config_file = 'jupyterhub_config.py'
# 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'
# Purge and reset the database.
# c.JupyterHub.reset_db = False
# The public facing port of the proxy
# c.JupyterHub.port = 8000
# Interval (in seconds) at which to check if the proxy is running.
# c.JupyterHub.proxy_check_interval = 30
#
# c.JupyterHub.tornado_settings = {}
# File in which to store the cookie secret.
# c.JupyterHub.cookie_secret_file = 'jupyterhub_cookie_secret'
# The class to use for spawning single-user servers.
#
# Should be a subclass of Spawner.
# c.JupyterHub.spawner_class = <class 'jupyterhub.spawner.LocalProcessSpawner'>
# Set the log level by value or name.
# c.JupyterHub.log_level = 30
# The ip for this process
# c.JupyterHub.hub_ip = 'ops.quantopian.com'
# Answer yes to any questions (e.g. confirm overwrite)
# c.JupyterHub.answer_yes = False
# Path to SSL certificate file for the public facing interface of the proxy
#
# Use with ssl_key
# c.JupyterHub.ssl_cert = ''
# The Proxy Auth token.
#
# Loaded from the CONFIGPROXY_AUTH_TOKEN env variable by default.
# c.JupyterHub.proxy_auth_token = ''
# The date format used by logging formatters for %(asctime)s
# c.JupyterHub.log_datefmt = '%Y-%m-%d %H:%M:%S'
# set of usernames of admin users
#
# If unspecified, only the user that launches the server will be admin.
# c.JupyterHub.admin_users = set()
# The ip for the proxy API handlers
# c.JupyterHub.proxy_api_ip = 'localhost'
# Path to SSL key file for the public facing interface of the proxy
#
# Use with ssl_cert
# c.JupyterHub.ssl_key = ''
# log all database transactions. This has A LOT of output
# c.JupyterHub.debug_db = False
# The location of jupyter data files (e.g. /usr/local/share/jupyter)
# c.JupyterHub.data_files_path = '/tmp/jupyterhub/share/jupyter'
# The public facing ip of the proxy
# c.JupyterHub.ip = 'ops.quantopian.com'
# The prefix for the hub server. Must not be '/'
# c.JupyterHub.hub_prefix = '/hub/'
# Interval (in seconds) at which to update last-activity timestamps.
# c.JupyterHub.last_activity_interval = 600
# The cookie secret to use to encrypt cookies.
#
# Loaded from the JPY_COOKIE_SECRET env variable by default.
# c.JupyterHub.cookie_secret = b''
# url for the database. e.g. `sqlite:///jupyterhub.sqlite`
# c.JupyterHub.db_url = 'sqlite:///jupyterhub.sqlite'
# File to write PID Useful for daemonizing jupyterhub.
# c.JupyterHub.pid_file = ''
# Generate default config file
# c.JupyterHub.generate_config = False
# The Logging format template
# c.JupyterHub.log_format = '[%(name)s]%(highlevel)s %(message)s'
# The port for the proxy API handlers
# c.JupyterHub.proxy_api_port = 0
# The port for this process
# c.JupyterHub.hub_port = 8081
# Supply extra arguments that will be passed to Jinja environment.
# c.JupyterHub.jinja_environment_options = {}
#------------------------------------------------------------------------------
# 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']
# 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']
# Enable debug-logging of the single-user server
# c.Spawner.debug = False
# Interval (in seconds) on which to poll the spawner.
# c.Spawner.poll_interval = 30
# The notebook directory for the single-user server
#
# `~` will be expanded to the user's home directory
# c.Spawner.notebook_dir = ''
#------------------------------------------------------------------------------
# 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 SIGTERM before proceeding to SIGKILL
# c.LocalProcessSpawner.TERM_TIMEOUT = 5
# The command used for starting notebooks.
# c.LocalProcessSpawner.cmd = ['jupyterhub-singleuser']
# Interval (in seconds) on which to poll the spawner.
# c.LocalProcessSpawner.poll_interval = 30
# The notebook directory for the single-user server
#
# `~` will be expanded to the user's home directory
# c.LocalProcessSpawner.notebook_dir = ''
# 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
# Seconds to wait for process to halt after SIGKILL before giving up
# c.LocalProcessSpawner.KILL_TIMEOUT = 5
# 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']
#------------------------------------------------------------------------------
# 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
# 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'
# Username whitelist.
#
# Use this to restrict which users can login. If empty, allow any user to
# attempt login.
# c.PAMAuthenticator.whitelist = set()
# The PAM service to use for authentication.
# c.PAMAuthenticator.service = 'login'