Docker安装配置JupyterNotebook详解

郑海江

因为Docker Hub无法打开，Jupyter Notebook等官方镜像也无法下载，所以另辟蹊径下载了热门的Python3基础镜像，从头开始安装纯净版本的Jupyter Notebook环境，本文记录了完整的Jupyter Notebook安装过程，方便自己查阅，也供其他人员参考，请确保当前已有Docker运行环境

直接拉取最新Python镜像，映射宿主机与容器内部目录，因为目前只用到Notebook的Web服务，所以只映射了一个端口开放使用

1. docker run -itd -p 2222:2222 -v /home/jupyter:/home/jupyter --name jupyter python

复制代码

进入镜像容器内部

1. docker exec -it `容器编号` /bin/bash

复制代码

设置pip下载镜像源为清华

1. pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple

复制代码

下载jupyter，默认会下载最新版本7.X的Notebook，但是目前最新版本安装nbextensions插件会报错，所以这里下载6.X的Notebook最后版本

1. pip install jupyter

复制代码

1. pip install jupyter notebook==6.5.5

复制代码

生成Jupyter默认配置文件，并自定义配置选项

1. jupyter notebook --generate-config

复制代码

生成配置文件后，控制台会打印生成的文件地址，通常是这个 /root/.jupyter/jupyter_notebook_config.py，如果生成的文件已经存在，会提示你是否需要覆盖，根据自己需要选择即可

因为此镜像没有Vim编辑器，我们可以按照如下步骤使用cat快速编辑保存配置

• 使用cat jupyter_notebook_config.py命令查看配置文件，并选中复制到电脑文本中
  
• 找到如下配置项，不同版本略有不同，但后缀相同，最后会附上当前完整配置以供参考
  
  
  
  • c.NotebookApp.allow_remote_access = True # 允许远程访问
    
  • c.NotebookApp.ip='0.0.0.0'  # 自动获取服务器ip
    
  • c.NotebookApp.allow_root =True  # 打开root权限启动
    
  • c.NotebookApp.open_browser = False #  服务端禁止自动打开浏览器
    
  • c.NotebookApp.port = 2222  # 创建docker时候配置的端口号
    
  
  
• 上面设置项改完后，可以复制编辑好的全部配置文件，使用命令cat > jupyter_notebook_config.py ，覆盖当前所有配置，最后 Ctrl+D保存文本，也可以使用命令cat >> jupyter_notebook_config.py  追加自己更改的设置项
  

配置文件成功后，可以在当前目录使用命令 jupyter notebook启动服务，控制台没什么报错的话会打印Jupyter Notebook访问地址链接，复制好链接中的token后面的值，我们便可以在打开的页面中输入token值，用来设置初始访问密码

当然我们可以事先生成密码，然后设置到配置文件中，但是上面的方法更为简单，以下方法仅供参考

• ipython
  
• from notebook.auth import passwd
  
• passwd()
  
• Enter password: XXXX
  
• Verify password: XXXX
  
• Out[2]: '生成的密钥'
  

复制生成的密钥，填入配置文件的 c.NotebookApp.password 项中 注意前面有 u

示例 c.NotebookApp.password=u'生成的密钥'

后台运行Jupyter Notebook

上面使用命令jupyter notebook启动服务后，控制台不方便执行其他命令，可以先使用Ctrl+C中断服务，在当前目录下使用nohup jupyter notebook &以启动后台服务，默认当前目录为工作目录，新建的文件会保存在此处，也可以指定工作目录，如jupyter notebook --notebook-dir='工作目录地址',注意，如果当前端口存在冲突时，Jupyter服务的端口会自动顺延至下一个可用的端口，会导致服务无法访问，可以使用命令 ps aux |grep note查看当前是否已存在运行服务，然后使用kill -9 服务的PID杀掉对应进程

下载插件管理器nbextensions，并安装

1. pip install jupyter_contrib_nbextensions && jupyter contrib nbextension install --user

复制代码

当前我开启的插件，根据自己需求来

• Export Embedded HTML
  
• RISE
  
• Hinterland
  
• Nbextensions dashboard tab
  
• Table of Contents (2)
  
• Variable Inspector
  
• Code prettify
  
• Hide input all
  
• Nbextensions edit menu item
  
• zenmode
  

使用主题(优雅的主题更舒心)

1. pip install jupyterthemes

复制代码

可以使用 jt -ls 查看当前所有主题名称，jt -t 主题名称可以切换到对应主题，切换主题，通常无需重启Jupyter Notebook，刷新Notebook页面即可看到变化，最后可以使用jt -r还原为默认主题

附我当前使用的主题配置 jt -t gruvboxd -fs 12 -cellw 80% -ofs 11 -dfs 11 -T -N

说明 -f(字体)  -fs(字体大小) -cellw(占屏比或宽度)  -ofs(输出段的字号)  -T(显示工具栏)  -N(显示自己主机名)

看自己需要，是否需要安装下面插件

• 报表展示 pip install plotly_express
  
• 报表展示 pip install pyecharts
  
• 查看当前系统环境信息 pip install watermark
  
• 幻灯片插件 pip install rise
  

1. %load_ext watermark
2. %watermark

复制代码

查看当前Jupyter中已有的核心包版本

1. jupyter --version

复制代码

附 jupyter-notebook完整配置文件

1. # Configuration file for jupyter-notebook.
3. c = get_config()  #noqa
5. #------------------------------------------------------------------------------
6. # Application(SingletonConfigurable) configuration
7. #------------------------------------------------------------------------------
8. ## This is an application.
10. ## The date format used by logging formatters for %(asctime)s
11. #  Default: '%Y-%m-%d %H:%M:%S'
12. # c.Application.log_datefmt = '%Y-%m-%d %H:%M:%S'
14. ## The Logging format template
15. #  Default: '[%(name)s]%(highlevel)s %(message)s'
16. # c.Application.log_format = '[%(name)s]%(highlevel)s %(message)s'
18. ## Set the log level by value or name.
19. #  Choices: any of [0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']
20. #  Default: 30
21. # c.Application.log_level = 30
23. ## Configure additional log handlers.
24. #
25. #  The default stderr logs handler is configured by the log_level, log_datefmt
26. #  and log_format settings.
27. #
28. #  This configuration can be used to configure additional handlers (e.g. to
29. #  output the log to a file) or for finer control over the default handlers.
30. #
31. #  If provided this should be a logging configuration dictionary, for more
32. #  information see:
33. #  https://docs.python.org/3/library/logging.config.html#logging-config-
34. #  dictschema
35. #
36. #  This dictionary is merged with the base logging configuration which defines
37. #  the following:
38. #
39. #  * A logging formatter intended for interactive use called
40. #    ``console``.
41. #  * A logging handler that writes to stderr called
42. #    ``console`` which uses the formatter ``console``.
43. #  * A logger with the name of this application set to ``DEBUG``
44. #    level.
45. #
46. #  This example adds a new handler that writes to a file:
47. #
48. #  .. code-block:: python
49. #
50. #     c.Application.logging_config = {
51. #         'handlers': {
52. #             'file': {
53. #                 'class': 'logging.FileHandler',
54. #                 'level': 'DEBUG',
55. #                 'filename': '<path/to/file>',
56. #             }
57. #         },
58. #         'loggers': {
59. #             '<application-name>': {
60. #                 'level': 'DEBUG',
61. #                 # NOTE: if you don't list the default "console"
62. #                 # handler here then it will be disabled
63. #                 'handlers': ['console', 'file'],
64. #             },
65. #         }
66. #     }
67. #  Default: {}
68. # c.Application.logging_config = {}
70. ## Instead of starting the Application, dump configuration to stdout
71. #  Default: False
72. # c.Application.show_config = False
74. ## Instead of starting the Application, dump configuration to stdout (as JSON)
75. #  Default: False
76. # c.Application.show_config_json = False
78. #------------------------------------------------------------------------------
79. # JupyterApp(Application) configuration
80. #------------------------------------------------------------------------------
81. ## Base class for Jupyter applications
83. ## Answer yes to any prompts.
84. #  Default: False
85. # c.JupyterApp.answer_yes = False
87. ## Full path of a config file.
88. #  Default: ''
89. # c.JupyterApp.config_file = ''
91. ## Specify a config file to load.
92. #  Default: ''
93. # c.JupyterApp.config_file_name = ''
95. ## Generate default config file.
96. #  Default: False
97. # c.JupyterApp.generate_config = False
99. ## The date format used by logging formatters for %(asctime)s
100. #  See also: Application.log_datefmt
101. # c.JupyterApp.log_datefmt = '%Y-%m-%d %H:%M:%S'
103. ## The Logging format template
104. #  See also: Application.log_format
105. # c.JupyterApp.log_format = '[%(name)s]%(highlevel)s %(message)s'
107. ## Set the log level by value or name.
108. #  See also: Application.log_level
109. # c.JupyterApp.log_level = 30
111. ##
112. #  See also: Application.logging_config
113. # c.JupyterApp.logging_config = {}
115. ## Instead of starting the Application, dump configuration to stdout
116. #  See also: Application.show_config
117. # c.JupyterApp.show_config = False
119. ## Instead of starting the Application, dump configuration to stdout (as JSON)
120. #  See also: Application.show_config_json
121. # c.JupyterApp.show_config_json = False
123. #------------------------------------------------------------------------------
124. # NotebookApp(JupyterApp) configuration
125. #------------------------------------------------------------------------------
126. ## Set the Access-Control-Allow-Credentials: true header
127. #  Default: False
128. # c.NotebookApp.allow_credentials = False
130. ## Set the Access-Control-Allow-Origin header
131. #
132. #          Use '*' to allow any origin to access your server.
133. #
134. #          Takes precedence over allow_origin_pat.
135. #  Default: ''
136. # c.NotebookApp.allow_origin = ''
138. ## Use a regular expression for the Access-Control-Allow-Origin header
139. #
140. #          Requests from an origin matching the expression will get replies with:
141. #
142. #              Access-Control-Allow-Origin: origin
143. #
144. #          where `origin` is the origin of the request.
145. #
146. #          Ignored if allow_origin is set.
147. #  Default: ''
148. # c.NotebookApp.allow_origin_pat = ''
150. ## Allow password to be changed at login for the notebook server.
151. #
152. #                      While logging in with a token, the notebook server UI will give the opportunity to
153. #                      the user to enter a new password at the same time that will replace
154. #                      the token login mechanism.
155. #
156. #                      This can be set to false to prevent changing password from
157. #  the UI/API.
158. #  Default: True
159. # c.NotebookApp.allow_password_change = True
161. ## Allow requests where the Host header doesn't point to a local server
162. #
163. #         By default, requests get a 403 forbidden response if the 'Host' header
164. #         shows that the browser thinks it's on a non-local domain.
165. #         Setting this option to True disables this check.
166. #
167. #         This protects against 'DNS rebinding' attacks, where a remote web server
168. #         serves you a page and then changes its DNS to send later requests to a
169. #         local IP, bypassing same-origin checks.
170. #
171. #         Local IP addresses (such as 127.0.0.1 and ::1) are allowed as local,
172. #         along with hostnames configured in local_hostnames.
173. #  Default: False
174. c.NotebookApp.allow_remote_access = True
176. ## Whether to allow the user to run the notebook as root.
177. #  Default: False
178. c.NotebookApp.allow_root = True
180. ## Answer yes to any prompts.
181. #  See also: JupyterApp.answer_yes
182. # c.NotebookApp.answer_yes = False
184. ## "
185. #          Require authentication to access prometheus metrics.
186. #  Default: True
187. # c.NotebookApp.authenticate_prometheus = True
189. ## Reload the webapp when changes are made to any Python src files.
190. #  Default: False
191. # c.NotebookApp.autoreload = False
193. ## DEPRECATED use base_url
194. #  Default: '/'
195. # c.NotebookApp.base_project_url = '/'
197. ## The base URL for the notebook server.
198. #
199. #                                 Leading and trailing slashes can be omitted,
200. #                                 and will automatically be added.
201. #  Default: '/'
202. # c.NotebookApp.base_url = '/'
204. ## Specify what command to use to invoke a web
205. #                        browser when opening the notebook. If not specified, the
206. #                        default browser will be determined by the `webbrowser`
207. #                        standard library module, which allows setting of the
208. #                        BROWSER environment variable to override it.
209. #  Default: ''
210. # c.NotebookApp.browser = ''
212. ## The full path to an SSL/TLS certificate file.
213. #  Default: ''
214. # c.NotebookApp.certfile = ''
216. ## The full path to a certificate authority certificate for SSL/TLS client
217. #  authentication.
218. #  Default: ''
219. # c.NotebookApp.client_ca = ''
221. ## Full path of a config file.
222. #  See also: JupyterApp.config_file
223. # c.NotebookApp.config_file = ''
225. ## Specify a config file to load.
226. #  See also: JupyterApp.config_file_name
227. # c.NotebookApp.config_file_name = ''
229. ## The config manager class to use
230. #  Default: 'notebook.services.config.manager.ConfigManager'
231. # c.NotebookApp.config_manager_class = 'notebook.services.config.manager.ConfigManager'
233. ## The notebook manager class to use.
234. #  Default: 'notebook.services.contents.largefilemanager.LargeFileManager'
235. # c.NotebookApp.contents_manager_class = 'notebook.services.contents.largefilemanager.LargeFileManager'
237. ## Extra keyword arguments to pass to `set_secure_cookie`. See tornado's
238. #  set_secure_cookie docs for details.
239. #  Default: {}
240. # c.NotebookApp.cookie_options = {}
242. ## The random bytes used to secure cookies.
243. #          By default this is a new random number every time you start the Notebook.
244. #          Set it to a value in a config file to enable logins to persist across server sessions.
245. #
246. #          Note: Cookie secrets should be kept private, do not share config files with
247. #          cookie_secret stored in plaintext (you can read the value from a file).
248. #  Default: b''
249. # c.NotebookApp.cookie_secret = b''
251. ## The file where the cookie secret is stored.
252. #  Default: ''
253. # c.NotebookApp.cookie_secret_file = ''
255. ## Override URL shown to users.
256. #
257. #          Replace actual URL, including protocol, address, port and base URL,
258. #          with the given value when displaying URL to the users. Do not change
259. #          the actual connection URL. If authentication token is enabled, the
260. #          token is added to the custom URL automatically.
261. #
262. #          This option is intended to be used when the URL to display to the user
263. #          cannot be determined reliably by the Jupyter notebook server (proxified
264. #          or containerized setups for example).
265. #  Default: ''
266. # c.NotebookApp.custom_display_url = ''
268. ## The default URL to redirect to from `/`
269. #  Default: '/tree'
270. # c.NotebookApp.default_url = '/tree'
272. ## Disable cross-site-request-forgery protection
273. #
274. #          Jupyter notebook 4.3.1 introduces protection from cross-site request forgeries,
275. #          requiring API requests to either:
276. #
277. #          - originate from pages served by this server (validated with XSRF cookie and token), or
278. #          - authenticate with a token
279. #
280. #          Some anonymous compute resources still desire the ability to run code,
281. #          completely without authentication.
282. #          These services can disable all authentication and security checks,
283. #          with the full knowledge of what that implies.
284. #  Default: False
285. # c.NotebookApp.disable_check_xsrf = False
287. ## Whether to enable MathJax for typesetting math/TeX
288. #
289. #          MathJax is the javascript library Jupyter uses to render math/LaTeX. It is
290. #          very large, so you may want to disable it if you have a slow internet
291. #          connection, or for offline use of the notebook.
292. #
293. #          When disabled, equations etc. will appear as their untransformed TeX
294. #  source.
295. #  Default: True
296. # c.NotebookApp.enable_mathjax = True
298. ## extra paths to look for Javascript notebook extensions
299. #  Default: []
300. # c.NotebookApp.extra_nbextensions_path = []
302. ## handlers that should be loaded at higher priority than the default services
303. #  Default: []
304. # c.NotebookApp.extra_services = []
306. ## Extra paths to search for serving static files.
307. #
308. #          This allows adding javascript/css to be available from the notebook server machine,
309. #          or overriding individual files in the IPython
310. #  Default: []
311. # c.NotebookApp.extra_static_paths = []
313. ## Extra paths to search for serving jinja templates.
314. #
315. #          Can be used to override templates from notebook.templates.
316. #  Default: []
317. # c.NotebookApp.extra_template_paths = []
319. #  Default: ''
320. # c.NotebookApp.file_to_run = ''
322. ## Generate default config file.
323. #  See also: JupyterApp.generate_config
324. # c.NotebookApp.generate_config = False
326. ## Extra keyword arguments to pass to `get_secure_cookie`. See tornado's
327. #  get_secure_cookie docs for details.
328. #  Default: {}
329. # c.NotebookApp.get_secure_cookie_kwargs = {}
331. ## Deprecated: Use minified JS file or not, mainly use during dev to avoid JS
332. #  recompilation
333. #  Default: False
334. # c.NotebookApp.ignore_minified_js = False
336. ## (bytes/sec)
337. #          Maximum rate at which stream output can be sent on iopub before they are
338. #          limited.
339. #  Default: 1000000
340. # c.NotebookApp.iopub_data_rate_limit = 1000000
342. ## (msgs/sec)
343. #          Maximum rate at which messages can be sent on iopub before they are
344. #          limited.
345. #  Default: 1000
346. # c.NotebookApp.iopub_msg_rate_limit = 1000
348. ## The IP address the notebook server will listen on.
349. #  Default: 'localhost'
350. c.NotebookApp.ip = '0.0.0.0'
352. ## Supply extra arguments that will be passed to Jinja environment.
353. #  Default: {}
354. # c.NotebookApp.jinja_environment_options = {}
356. ## Extra variables to supply to jinja templates when rendering.
357. #  Default: {}
358. # c.NotebookApp.jinja_template_vars = {}
360. ## The kernel manager class to use.
361. #  Default: 'notebook.services.kernels.kernelmanager.MappingKernelManager'
362. # c.NotebookApp.kernel_manager_class = 'notebook.services.kernels.kernelmanager.MappingKernelManager'
364. ## The kernel spec manager class to use. Should be a subclass of
365. #  `jupyter_client.kernelspec.KernelSpecManager`.
366. #
367. #  The Api of KernelSpecManager is provisional and might change without warning
368. #  between this version of Jupyter and the next stable one.
369. #  Default: 'jupyter_client.kernelspec.KernelSpecManager'
370. # c.NotebookApp.kernel_spec_manager_class = 'jupyter_client.kernelspec.KernelSpecManager'
372. ## The full path to a private key file for usage with SSL/TLS.
373. #  Default: ''
374. # c.NotebookApp.keyfile = ''
376. ## Hostnames to allow as local when allow_remote_access is False.
377. #
378. #         Local IP addresses (such as 127.0.0.1 and ::1) are automatically accepted
379. #         as local as well.
380. #  Default: ['localhost']
381. # c.NotebookApp.local_hostnames = ['localhost']
383. ## The date format used by logging formatters for %(asctime)s
384. #  See also: Application.log_datefmt
385. # c.NotebookApp.log_datefmt = '%Y-%m-%d %H:%M:%S'
387. ## The Logging format template
388. #  See also: Application.log_format
389. # c.NotebookApp.log_format = '[%(name)s]%(highlevel)s %(message)s'
391. ## Set to True to enable JSON formatted logs. Run "pip install notebook[json-
392. #  logging]" to install the required dependent packages. Can also be set using
393. #  the environment variable JUPYTER_ENABLE_JSON_LOGGING=true.
394. #  Default: False
395. # c.NotebookApp.log_json = False
397. ## Set the log level by value or name.
398. #  See also: Application.log_level
399. # c.NotebookApp.log_level = 30
401. ##
402. #  See also: Application.logging_config
403. # c.NotebookApp.logging_config = {}
405. ## The login handler class to use.
406. #  Default: 'notebook.auth.login.LoginHandler'
407. # c.NotebookApp.login_handler_class = 'notebook.auth.login.LoginHandler'
409. ## The logout handler class to use.
410. #  Default: 'notebook.auth.logout.LogoutHandler'
411. # c.NotebookApp.logout_handler_class = 'notebook.auth.logout.LogoutHandler'
413. ## The MathJax.js configuration file that is to be used.
414. #  Default: 'TeX-AMS-MML_HTMLorMML-full,Safe'
415. # c.NotebookApp.mathjax_config = 'TeX-AMS-MML_HTMLorMML-full,Safe'
417. ## A custom url for MathJax.js.
418. #          Should be in the form of a case-sensitive url to MathJax,
419. #          for example:  /static/components/MathJax/MathJax.js
420. #  Default: ''
421. # c.NotebookApp.mathjax_url = ''
423. ## Sets the maximum allowed size of the client request body, specified in the
424. #  Content-Length request header field. If the size in a request exceeds the
425. #  configured value, a malformed HTTP message is returned to the client.
426. #
427. #  Note: max_body_size is applied even in streaming mode.
428. #  Default: 536870912
429. # c.NotebookApp.max_body_size = 536870912
431. ## Gets or sets the maximum amount of memory, in bytes, that is allocated for use
432. #  by the buffer manager.
433. #  Default: 536870912
434. # c.NotebookApp.max_buffer_size = 536870912
436. ## Gets or sets a lower bound on the open file handles process resource limit.
437. #  This may need to be increased if you run into an OSError: [Errno 24] Too many
438. #  open files. This is not applicable when running on Windows.
439. #  Default: 0
440. # c.NotebookApp.min_open_files_limit = 0
442. ## Dict of Python modules to load as notebook server extensions. Entry values can
443. #  be used to enable and disable the loading of the extensions. The extensions
444. #  will be loaded in alphabetical order.
445. #  Default: {}
446. # c.NotebookApp.nbserver_extensions = {}
448. ## The directory to use for notebooks and kernels.
449. #  Default: ''
450. # c.NotebookApp.notebook_dir = ''
452. ## Whether to open in a browser after starting.
453. #                          The specific browser used is platform dependent and
454. #                          determined by the python standard library `webbrowser`
455. #                          module, unless it is overridden using the --browser
456. #                          (NotebookApp.browser) configuration option.
457. #  Default: True
458. c.NotebookApp.open_browser = False
460. ## Hashed password to use for web authentication.
461. #
462. #                        To generate, type in a python/IPython shell:
463. #
464. #                          from notebook.auth import passwd; passwd()
465. #
466. #                        The string should be of the form type:salt:hashed-
467. #  password.
468. #  Default: ''
469. # c.NotebookApp.password = ''
471. ## Forces users to use a password for the Notebook server.
472. #                        This is useful in a multi user environment, for instance when
473. #                        everybody in the LAN can access each other's machine through ssh.
474. #
475. #                        In such a case, serving the notebook server on localhost is not secure
476. #                        since any user can connect to the notebook server via ssh.
477. #  Default: False
478. # c.NotebookApp.password_required = False
480. ## The port the notebook server will listen on (env: JUPYTER_PORT).
481. #  Default: 8888
482. c.NotebookApp.port = 2222
484. ## The number of additional ports to try if the specified port is not available
485. #  (env: JUPYTER_PORT_RETRIES).
486. #  Default: 50
487. # c.NotebookApp.port_retries = 50
489. ## DISABLED: use %pylab or %matplotlib in the notebook to enable matplotlib.
490. #  Default: 'disabled'
491. # c.NotebookApp.pylab = 'disabled'
493. ## If True, display a button in the dashboard to quit
494. #          (shutdown the notebook server).
495. #  Default: True
496. # c.NotebookApp.quit_button = True
498. ## (sec) Time window used to
499. #          check the message and data rate limits.
500. #  Default: 3
501. # c.NotebookApp.rate_limit_window = 3
503. ## Reraise exceptions encountered loading server extensions?
504. #  Default: False
505. # c.NotebookApp.reraise_server_extension_failures = False
507. ## DEPRECATED use the nbserver_extensions dict instead
508. #  Default: []
509. # c.NotebookApp.server_extensions = []
511. ## The session manager class to use.
512. #  Default: 'notebook.services.sessions.sessionmanager.SessionManager'
513. # c.NotebookApp.session_manager_class = 'notebook.services.sessions.sessionmanager.SessionManager'
515. ## Whether the banner is displayed on the page.
516. #
517. #                          By default, the banner is displayed.
518. #  Default: True
519. # c.NotebookApp.show_banner = True
521. ## Instead of starting the Application, dump configuration to stdout
522. #  See also: Application.show_config
523. # c.NotebookApp.show_config = False
525. ## Instead of starting the Application, dump configuration to stdout (as JSON)
526. #  See also: Application.show_config_json
527. # c.NotebookApp.show_config_json = False
529. ## Shut down the server after N seconds with no kernels or terminals running and
530. #  no activity. This can be used together with culling idle kernels
531. #  (MappingKernelManager.cull_idle_timeout) to shutdown the notebook server when
532. #  it's not in use. This is not precisely timed: it may shut down up to a minute
533. #  later. 0 (the default) disables this automatic shutdown.
534. #  Default: 0
535. # c.NotebookApp.shutdown_no_activity_timeout = 0
537. ## The UNIX socket the notebook server will listen on.
538. #  Default: ''
539. # c.NotebookApp.sock = ''
541. ## The permissions mode for UNIX socket creation (default: 0600).
542. #  Default: '0600'
543. # c.NotebookApp.sock_mode = '0600'
545. ## Supply SSL options for the tornado HTTPServer.
546. #              See the tornado docs for details.
547. #  Default: {}
548. # c.NotebookApp.ssl_options = {}
550. ## Supply overrides for terminado. Currently only supports "shell_command". On
551. #  Unix, if "shell_command" is not provided, a non-login shell is launched by
552. #  default when the notebook server is connected to a terminal, a login shell
553. #  otherwise.
554. #  Default: {}
555. # c.NotebookApp.terminado_settings = {}
557. ## Set to False to disable terminals.
558. #
559. #           This does *not* make the notebook server more secure by itself.
560. #           Anything the user can in a terminal, they can also do in a notebook.
561. #
562. #           Terminals may also be automatically disabled if the terminado package
563. #           is not available.
564. #  Default: True
565. # c.NotebookApp.terminals_enabled = True
567. ## Token used for authenticating first-time connections to the server.
568. #
569. #          The token can be read from the file referenced by JUPYTER_TOKEN_FILE or set directly
570. #          with the JUPYTER_TOKEN environment variable.
571. #
572. #          When no password is enabled,
573. #          the default is to generate a new, random token.
574. #
575. #          Setting to an empty string disables authentication altogether, which
576. #  is NOT RECOMMENDED.
577. #  Default: '<generated>'
578. # c.NotebookApp.token = '<generated>'
580. ## Supply overrides for the tornado.web.Application that the Jupyter notebook
581. #  uses.
582. #  Default: {}
583. # c.NotebookApp.tornado_settings = {}
585. ## Whether to trust or not X-Scheme/X-Forwarded-Proto and X-Real-Ip/X-Forwarded-
586. #  For headers sent by the upstream reverse proxy. Necessary if the proxy handles
587. #  SSL
588. #  Default: False
589. # c.NotebookApp.trust_xheaders = False
591. ## Disable launching browser by redirect file
592. #
593. #          For versions of notebook > 5.7.2, a security feature measure was added that
594. #          prevented the authentication token used to launch the browser from being visible.
595. #          This feature makes it difficult for other users on a multi-user system from
596. #          running code in your Jupyter session as you.
597. #
598. #          However, some environments (like Windows Subsystem for Linux (WSL) and Chromebooks),
599. #          launching a browser using a redirect file can lead the browser failing to load.
600. #          This is because of the difference in file structures/paths between the runtime and
601. #          the browser.
602. #
603. #          Disabling this setting to False will disable this behavior, allowing the browser
604. #          to launch by using a URL and visible token (as before).
605. #  Default: True
606. # c.NotebookApp.use_redirect_file = True
608. ## DEPRECATED, use tornado_settings
609. #  Default: {}
610. # c.NotebookApp.webapp_settings = {}
612. ## Specify Where to open the notebook on startup. This is the
613. #          `new` argument passed to the standard library method `webbrowser.open`.
614. #          The behaviour is not guaranteed, but depends on browser support. Valid
615. #          values are:
616. #
617. #           - 2 opens a new tab,
618. #           - 1 opens a new window,
619. #           - 0 opens in an existing window.
620. #
621. #          See the `webbrowser.open` documentation for details.
622. #  Default: 2
623. # c.NotebookApp.webbrowser_open_new = 2
625. ## Set the tornado compression options for websocket connections.
626. #
627. #  This value will be returned from
628. #  :meth:`WebSocketHandler.get_compression_options`. None (default) will disable
629. #  compression. A dict (even an empty one) will enable compression.
630. #
631. #  See the tornado docs for WebSocketHandler.get_compression_options for details.
632. #  Default: None
633. # c.NotebookApp.websocket_compression_options = None
635. ## The base URL for websockets,
636. #          if it differs from the HTTP server (hint: it almost certainly doesn't).
637. #
638. #          Should be in the form of an HTTP origin: ws[s]://hostname[:port]
639. #  Default: ''
640. # c.NotebookApp.websocket_url = ''
642. #------------------------------------------------------------------------------
643. # ConnectionFileMixin(LoggingConfigurable) configuration
644. #------------------------------------------------------------------------------
645. ## Mixin for configurable classes that work with connection files
647. ## JSON file in which to store connection info [default: kernel-<pid>.json]
648. #
649. #      This file will contain the IP, ports, and authentication key needed to connect
650. #      clients to this kernel. By default, this file will be created in the security dir
651. #      of the current profile, but can be specified by absolute path.
652. #  Default: ''
653. # c.ConnectionFileMixin.connection_file = ''
655. ## set the control (ROUTER) port [default: random]
656. #  Default: 0
657. # c.ConnectionFileMixin.control_port = 0
659. ## set the heartbeat port [default: random]
660. #  Default: 0
661. # c.ConnectionFileMixin.hb_port = 0
663. ## set the iopub (PUB) port [default: random]
664. #  Default: 0
665. # c.ConnectionFileMixin.iopub_port = 0
667. ## Set the kernel's IP address [default localhost].
668. #          If the IP address is something other than localhost, then
669. #          Consoles on other machines will be able to connect
670. #          to the Kernel, so be careful!
671. #  Default: ''
672. # c.ConnectionFileMixin.ip = ''
674. ## set the shell (ROUTER) port [default: random]
675. #  Default: 0
676. # c.ConnectionFileMixin.shell_port = 0
678. ## set the stdin (ROUTER) port [default: random]
679. #  Default: 0
680. # c.ConnectionFileMixin.stdin_port = 0
682. #  Choices: any of ['tcp', 'ipc'] (case-insensitive)
683. #  Default: 'tcp'
684. # c.ConnectionFileMixin.transport = 'tcp'
686. #------------------------------------------------------------------------------
687. # KernelManager(ConnectionFileMixin) configuration
688. #------------------------------------------------------------------------------
689. ## Manages a single kernel in a subprocess on this host.
690. #
691. #      This version starts kernels with Popen.
693. ## Should we autorestart the kernel if it dies.
694. #  Default: True
695. # c.KernelManager.autorestart = True
697. ## JSON file in which to store connection info [default: kernel-<pid>.json]
698. #  See also: ConnectionFileMixin.connection_file
699. # c.KernelManager.connection_file = ''
701. ## set the control (ROUTER) port [default: random]
702. #  See also: ConnectionFileMixin.control_port
703. # c.KernelManager.control_port = 0
705. ## set the heartbeat port [default: random]
706. #  See also: ConnectionFileMixin.hb_port
707. # c.KernelManager.hb_port = 0
709. ## set the iopub (PUB) port [default: random]
710. #  See also: ConnectionFileMixin.iopub_port
711. # c.KernelManager.iopub_port = 0
713. ## Set the kernel's IP address [default localhost].
714. #  See also: ConnectionFileMixin.ip
715. # c.KernelManager.ip = ''
717. ## set the shell (ROUTER) port [default: random]
718. #  See also: ConnectionFileMixin.shell_port
719. # c.KernelManager.shell_port = 0
721. ## Time to wait for a kernel to terminate before killing it, in seconds. When a
722. #  shutdown request is initiated, the kernel will be immediately sent an
723. #  interrupt (SIGINT), followedby a shutdown_request message, after 1/2 of
724. #  `shutdown_wait_time`it will be sent a terminate (SIGTERM) request, and finally
725. #  at the end of `shutdown_wait_time` will be killed (SIGKILL). terminate and
726. #  kill may be equivalent on windows.  Note that this value can beoverridden by
727. #  the in-use kernel provisioner since shutdown times mayvary by provisioned
728. #  environment.
729. #  Default: 5.0
730. # c.KernelManager.shutdown_wait_time = 5.0
732. ## set the stdin (ROUTER) port [default: random]
733. #  See also: ConnectionFileMixin.stdin_port
734. # c.KernelManager.stdin_port = 0
736. #  See also: ConnectionFileMixin.transport
737. # c.KernelManager.transport = 'tcp'
739. #------------------------------------------------------------------------------
740. # Session(Configurable) configuration
741. #------------------------------------------------------------------------------
742. ## Object for handling serialization and sending of messages.
743. #
744. #      The Session object handles building messages and sending them
745. #      with ZMQ sockets or ZMQStream objects.  Objects can communicate with each
746. #      other over the network via Session objects, and only need to work with the
747. #      dict-based IPython message spec. The Session will handle
748. #      serialization/deserialization, security, and metadata.
749. #
750. #      Sessions support configurable serialization via packer/unpacker traits,
751. #      and signing with HMAC digests via the key/keyfile traits.
752. #
753. #      Parameters
754. #      ----------
755. #
756. #      debug : bool
757. #          whether to trigger extra debugging statements
758. #      packer/unpacker : str : 'json', 'pickle' or import_string
759. #          importstrings for methods to serialize message parts.  If just
760. #          'json' or 'pickle', predefined JSON and pickle packers will be used.
761. #          Otherwise, the entire importstring must be used.
762. #
763. #          The functions must accept at least valid JSON input, and output
764. #  *bytes*.
765. #
766. #          For example, to use msgpack:
767. #          packer = 'msgpack.packb', unpacker='msgpack.unpackb'
768. #      pack/unpack : callables
769. #          You can also set the pack/unpack callables for serialization directly.
770. #      session : bytes
771. #          the ID of this Session object.  The default is to generate a new UUID.
772. #      username : unicode
773. #          username added to message headers.  The default is to ask the OS.
774. #      key : bytes
775. #          The key used to initialize an HMAC signature.  If unset, messages
776. #          will not be signed or checked.
777. #      keyfile : filepath
778. #          The file containing a key.  If this is set, `key` will be initialized
779. #          to the contents of the file.
781. ## Threshold (in bytes) beyond which an object's buffer should be extracted to
782. #  avoid pickling.
783. #  Default: 1024
784. # c.Session.buffer_threshold = 1024
786. ## Whether to check PID to protect against calls after fork.
787. #
788. #          This check can be disabled if fork-safety is handled elsewhere.
789. #  Default: True
790. # c.Session.check_pid = True
792. ## Threshold (in bytes) beyond which a buffer should be sent without copying.
793. #  Default: 65536
794. # c.Session.copy_threshold = 65536
796. ## Debug output in the Session
797. #  Default: False
798. # c.Session.debug = False
800. ## The maximum number of digests to remember.
801. #
802. #          The digest history will be culled when it exceeds this value.
803. #  Default: 65536
804. # c.Session.digest_history_size = 65536
806. ## The maximum number of items for a container to be introspected for custom serialization.
807. #          Containers larger than this are pickled outright.
808. #  Default: 64
809. # c.Session.item_threshold = 64
811. ## execution key, for signing messages.
812. #  Default: b''
813. # c.Session.key = b''
815. ## path to file containing execution key.
816. #  Default: ''
817. # c.Session.keyfile = ''
819. ## Metadata dictionary, which serves as the default top-level metadata dict for
820. #  each message.
821. #  Default: {}
822. # c.Session.metadata = {}
824. ## The name of the packer for serializing messages.
825. #              Should be one of 'json', 'pickle', or an import name
826. #              for a custom callable serializer.
827. #  Default: 'json'
828. # c.Session.packer = 'json'
830. ## The UUID identifying this session.
831. #  Default: ''
832. # c.Session.session = ''
834. ## The digest scheme used to construct the message signatures.
835. #          Must have the form 'hmac-HASH'.
836. #  Default: 'hmac-sha256'
837. # c.Session.signature_scheme = 'hmac-sha256'
839. ## The name of the unpacker for unserializing messages.
840. #          Only used with custom functions for `packer`.
841. #  Default: 'json'
842. # c.Session.unpacker = 'json'
844. ## Username for the Session. Default is your system username.
845. #  Default: 'username'
846. # c.Session.username = 'username'
848. #------------------------------------------------------------------------------
849. # MultiKernelManager(LoggingConfigurable) configuration
850. #------------------------------------------------------------------------------
851. ## A class for managing multiple kernels.
853. ## The name of the default kernel to start
854. #  Default: 'python3'
855. # c.MultiKernelManager.default_kernel_name = 'python3'
857. ## The kernel manager class.  This is configurable to allow
858. #          subclassing of the KernelManager for customized behavior.
859. #  Default: 'jupyter_client.ioloop.IOLoopKernelManager'
860. # c.MultiKernelManager.kernel_manager_class = 'jupyter_client.ioloop.IOLoopKernelManager'
862. ## Share a single zmq.Context to talk to all my kernels
863. #  Default: True
864. # c.MultiKernelManager.shared_context = True
866. #------------------------------------------------------------------------------
867. # MappingKernelManager(MultiKernelManager) configuration
868. #------------------------------------------------------------------------------
869. ## A KernelManager that handles notebook mapping and HTTP error handling
871. ## White list of allowed kernel message types.
872. #          When the list is empty, all message types are allowed.
873. #  Default: []
874. # c.MappingKernelManager.allowed_message_types = []
876. ## Whether messages from kernels whose frontends have disconnected should be buffered in-memory.
877. #          When True (default), messages are buffered and replayed on reconnect,
878. #          avoiding lost messages due to interrupted connectivity.
879. #          Disable if long-running kernels will produce too much output while
880. #          no frontends are connected.
881. #  Default: True
882. # c.MappingKernelManager.buffer_offline_messages = True
884. ## Whether to consider culling kernels which are busy.
885. #          Only effective if cull_idle_timeout > 0.
886. #  Default: False
887. # c.MappingKernelManager.cull_busy = False
889. ## Whether to consider culling kernels which have one or more connections.
890. #          Only effective if cull_idle_timeout > 0.
891. #  Default: False
892. # c.MappingKernelManager.cull_connected = False
894. ## Timeout (in seconds) after which a kernel is considered idle and ready to be culled.
895. #          Values of 0 or lower disable culling. Very short timeouts may result in kernels being culled
896. #          for users with poor network connections.
897. #  Default: 0
898. # c.MappingKernelManager.cull_idle_timeout = 0
900. ## The interval (in seconds) on which to check for idle kernels exceeding the
901. #  cull timeout value.
902. #  Default: 300
903. # c.MappingKernelManager.cull_interval = 300
905. ## The name of the default kernel to start
906. #  See also: MultiKernelManager.default_kernel_name
907. # c.MappingKernelManager.default_kernel_name = 'python3'
909. ## Timeout for giving up on a kernel (in seconds).
910. #          On starting and restarting kernels, we check whether the
911. #          kernel is running and responsive by sending kernel_info_requests.
912. #          This sets the timeout in seconds for how long the kernel can take
913. #          before being presumed dead.
914. #          This affects the MappingKernelManager (which handles kernel restarts)
915. #          and the ZMQChannelsHandler (which handles the startup).
916. #  Default: 60
917. # c.MappingKernelManager.kernel_info_timeout = 60
919. ## The kernel manager class.  This is configurable to allow
920. #  See also: MultiKernelManager.kernel_manager_class
921. # c.MappingKernelManager.kernel_manager_class = 'jupyter_client.ioloop.IOLoopKernelManager'
923. #  Default: ''
924. # c.MappingKernelManager.root_dir = ''
926. ## Share a single zmq.Context to talk to all my kernels
927. #  See also: MultiKernelManager.shared_context
928. # c.MappingKernelManager.shared_context = True
930. #------------------------------------------------------------------------------
931. # KernelSpecManager(LoggingConfigurable) configuration
932. #------------------------------------------------------------------------------
933. ## List of allowed kernel names.
934. #
935. #          By default, all installed kernels are allowed.
936. #  Default: set()
937. # c.KernelSpecManager.allowed_kernelspecs = set()
939. ## If there is no Python kernelspec registered and the IPython
940. #          kernel is available, ensure it is added to the spec list.
941. #  Default: True
942. # c.KernelSpecManager.ensure_native_kernel = True
944. ## The kernel spec class.  This is configurable to allow
945. #          subclassing of the KernelSpecManager for customized behavior.
946. #  Default: 'jupyter_client.kernelspec.KernelSpec'
947. # c.KernelSpecManager.kernel_spec_class = 'jupyter_client.kernelspec.KernelSpec'
949. ## Deprecated, use `KernelSpecManager.allowed_kernelspecs`
950. #  Default: set()
951. # c.KernelSpecManager.whitelist = set()
953. #------------------------------------------------------------------------------
954. # ContentsManager(LoggingConfigurable) configuration
955. #------------------------------------------------------------------------------
956. ## Base class for serving files and directories.
957. #
958. #      This serves any text or binary file,
959. #      as well as directories,
960. #      with special handling for JSON notebook documents.
961. #
962. #      Most APIs take a path argument,
963. #      which is always an API-style unicode path,
964. #      and always refers to a directory.
965. #
966. #      - unicode, not url-escaped
967. #      - '/'-separated
968. #      - leading and trailing '/' will be stripped
969. #      - if unspecified, path defaults to '',
970. #        indicating the root path.
972. ## Allow access to hidden files
973. #  Default: False
974. # c.ContentsManager.allow_hidden = False
976. #  Default: None
977. # c.ContentsManager.checkpoints = None
979. #  Default: 'notebook.services.contents.checkpoints.Checkpoints'
980. # c.ContentsManager.checkpoints_class = 'notebook.services.contents.checkpoints.Checkpoints'
982. #  Default: {}
983. # c.ContentsManager.checkpoints_kwargs = {}
985. ## handler class to use when serving raw file requests.
986. #
987. #          Default is a fallback that talks to the ContentsManager API,
988. #          which may be inefficient, especially for large files.
989. #
990. #          Local files-based ContentsManagers can use a StaticFileHandler subclass,
991. #          which will be much more efficient.
992. #
993. #          Access to these files should be Authenticated.
994. #  Default: 'notebook.files.handlers.FilesHandler'
995. # c.ContentsManager.files_handler_class = 'notebook.files.handlers.FilesHandler'
997. ## Extra parameters to pass to files_handler_class.
998. #
999. #          For example, StaticFileHandlers generally expect a `path` argument
1000. #          specifying the root directory from which to serve files.
1001. #  Default: {}
1002. # c.ContentsManager.files_handler_params = {}
1004. ## Glob patterns to hide in file and directory listings.
1005. #  Default: ['__pycache__', '*.pyc', '*.pyo', '.DS_Store', '*.so', '*.dylib', '*~']
1006. # c.ContentsManager.hide_globs = ['__pycache__', '*.pyc', '*.pyo', '.DS_Store', '*.so', '*.dylib', '*~']
1008. ## Python callable or importstring thereof
1009. #
1010. #          To be called on a contents model prior to save.
1011. #
1012. #          This can be used to process the structure,
1013. #          such as removing notebook outputs or other side effects that
1014. #          should not be saved.
1015. #
1016. #          It will be called as (all arguments passed by keyword)::
1017. #
1018. #              hook(path=path, model=model, contents_manager=self)
1019. #
1020. #          - model: the model to be saved. Includes file contents.
1021. #            Modifying this dict will affect the file that is stored.
1022. #          - path: the API path of the save destination
1023. #          - contents_manager: this ContentsManager instance
1024. #  Default: None
1025. # c.ContentsManager.pre_save_hook = None
1027. #  Default: '/'
1028. # c.ContentsManager.root_dir = '/'
1030. ## The base name used when creating untitled directories.
1031. #  Default: 'Untitled Folder'
1032. # c.ContentsManager.untitled_directory = 'Untitled Folder'
1034. ## The base name used when creating untitled files.
1035. #  Default: 'untitled'
1036. # c.ContentsManager.untitled_file = 'untitled'
1038. ## The base name used when creating untitled notebooks.
1039. #  Default: 'Untitled'
1040. # c.ContentsManager.untitled_notebook = 'Untitled'
1042. #------------------------------------------------------------------------------
1043. # FileManagerMixin(Configurable) configuration
1044. #------------------------------------------------------------------------------
1045. ## Mixin for ContentsAPI classes that interact with the filesystem.
1046. #
1047. #  Provides facilities for reading, writing, and copying both notebooks and
1048. #  generic files.
1049. #
1050. #  Shared by FileContentsManager and FileCheckpoints.
1051. #
1052. #  Note ---- Classes using this mixin must provide the following attributes:
1053. #
1054. #  root_dir : unicode
1055. #      A directory against which API-style paths are to be resolved.
1056. #
1057. #  log : logging.Logger
1059. ## By default notebooks are saved on disk on a temporary file and then if successfully written, it replaces the old ones.
1060. #        This procedure, namely 'atomic_writing', causes some bugs on file system without operation order enforcement (like some networked fs).
1061. #        If set to False, the new notebook is written directly on the old one which could fail (eg: full filesystem or quota )
1062. #  Default: True
1063. # c.FileManagerMixin.use_atomic_writing = True
1065. #------------------------------------------------------------------------------
1066. # FileContentsManager(FileManagerMixin, ContentsManager) configuration
1067. #------------------------------------------------------------------------------
1068. ## Allow access to hidden files
1069. #  See also: ContentsManager.allow_hidden
1070. # c.FileContentsManager.allow_hidden = False
1072. #  See also: ContentsManager.checkpoints
1073. # c.FileContentsManager.checkpoints = None
1075. #  See also: ContentsManager.checkpoints_class
1076. # c.FileContentsManager.checkpoints_class = 'notebook.services.contents.checkpoints.Checkpoints'
1078. #  See also: ContentsManager.checkpoints_kwargs
1079. # c.FileContentsManager.checkpoints_kwargs = {}
1081. ## If True (default), deleting files will send them to the
1082. #          platform's trash/recycle bin, where they can be recovered. If False,
1083. #          deleting files really deletes them.
1084. #  Default: True
1085. # c.FileContentsManager.delete_to_trash = True
1087. ## handler class to use when serving raw file requests.
1088. #  See also: ContentsManager.files_handler_class
1089. # c.FileContentsManager.files_handler_class = 'notebook.files.handlers.FilesHandler'
1091. ## Extra parameters to pass to files_handler_class.
1092. #  See also: ContentsManager.files_handler_params
1093. # c.FileContentsManager.files_handler_params = {}
1095. ##
1096. #  See also: ContentsManager.hide_globs
1097. # c.FileContentsManager.hide_globs = ['__pycache__', '*.pyc', '*.pyo', '.DS_Store', '*.so', '*.dylib', '*~']
1099. ## Python callable or importstring thereof
1100. #
1101. #          to be called on the path of a file just saved.
1102. #
1103. #          This can be used to process the file on disk,
1104. #          such as converting the notebook to a script or HTML via nbconvert.
1105. #
1106. #          It will be called as (all arguments passed by keyword)::
1107. #
1108. #              hook(os_path=os_path, model=model, contents_manager=instance)
1109. #
1110. #          - path: the filesystem path to the file just written
1111. #          - model: the model representing the file
1112. #          - contents_manager: this ContentsManager instance
1113. #  Default: None
1114. # c.FileContentsManager.post_save_hook = None
1116. ## Python callable or importstring thereof
1117. #  See also: ContentsManager.pre_save_hook
1118. # c.FileContentsManager.pre_save_hook = None
1120. #  Default: ''
1121. # c.FileContentsManager.root_dir = ''
1123. ## DEPRECATED, use post_save_hook. Will be removed in Notebook 5.0
1124. #  Default: False
1125. # c.FileContentsManager.save_script = False
1127. ## The base name used when creating untitled directories.
1128. #  See also: ContentsManager.untitled_directory
1129. # c.FileContentsManager.untitled_directory = 'Untitled Folder'
1131. ## The base name used when creating untitled files.
1132. #  See also: ContentsManager.untitled_file
1133. # c.FileContentsManager.untitled_file = 'untitled'
1135. ## The base name used when creating untitled notebooks.
1136. #  See also: ContentsManager.untitled_notebook
1137. # c.FileContentsManager.untitled_notebook = 'Untitled'
1139. ## By default notebooks are saved on disk on a temporary file and then if
1140. #  successfully written, it replaces the old ones.
1141. #  See also: FileManagerMixin.use_atomic_writing
1142. # c.FileContentsManager.use_atomic_writing = True
1144. #------------------------------------------------------------------------------
1145. # NotebookNotary(LoggingConfigurable) configuration
1146. #------------------------------------------------------------------------------
1147. ## A class for computing and verifying notebook signatures.
1149. ## The hashing algorithm used to sign notebooks.
1150. #  Choices: any of ['sha512', 'sha384', 'sha3_512', 'sha3_256', 'md5', 'sha224', 'blake2s', 'sha1', 'sha3_224', 'sha256', 'blake2b', 'sha3_384']
1151. #  Default: 'sha256'
1152. # c.NotebookNotary.algorithm = 'sha256'
1154. ## The storage directory for notary secret and database.
1155. #  Default: ''
1156. # c.NotebookNotary.data_dir = ''
1158. ## The sqlite file in which to store notebook signatures.
1159. #          By default, this will be in your Jupyter data directory.
1160. #          You can set it to ':memory:' to disable sqlite writing to the filesystem.
1161. #  Default: ''
1162. # c.NotebookNotary.db_file = ''
1164. ## The secret key with which notebooks are signed.
1165. #  Default: b''
1166. # c.NotebookNotary.secret = b''
1168. ## The file where the secret key is stored.
1169. #  Default: ''
1170. # c.NotebookNotary.secret_file = ''
1172. ## A callable returning the storage backend for notebook signatures.
1173. #           The default uses an SQLite database.
1174. #  Default: traitlets.Undefined
1175. # c.NotebookNotary.store_factory = traitlets.Undefined
1177. #------------------------------------------------------------------------------
1178. # AsyncMultiKernelManager(MultiKernelManager) configuration
1179. #------------------------------------------------------------------------------
1180. ## The name of the default kernel to start
1181. #  See also: MultiKernelManager.default_kernel_name
1182. # c.AsyncMultiKernelManager.default_kernel_name = 'python3'
1184. ## The kernel manager class.  This is configurable to allow
1185. #          subclassing of the AsyncKernelManager for customized behavior.
1186. #  Default: 'jupyter_client.ioloop.AsyncIOLoopKernelManager'
1187. # c.AsyncMultiKernelManager.kernel_manager_class = 'jupyter_client.ioloop.AsyncIOLoopKernelManager'
1189. ## Share a single zmq.Context to talk to all my kernels
1190. #  See also: MultiKernelManager.shared_context
1191. # c.AsyncMultiKernelManager.shared_context = True
1193. ## Whether to make kernels available before the process has started.  The
1194. #          kernel has a `.ready` future which can be awaited before connecting
1195. #  Default: False
1196. # c.AsyncMultiKernelManager.use_pending_kernels = False
1198. #------------------------------------------------------------------------------
1199. # AsyncMappingKernelManager(MappingKernelManager, AsyncMultiKernelManager) configuration
1200. #------------------------------------------------------------------------------
1201. ## White list of allowed kernel message types.
1202. #  See also: MappingKernelManager.allowed_message_types
1203. # c.AsyncMappingKernelManager.allowed_message_types = []
1205. ## Whether messages from kernels whose frontends have disconnected should be
1206. #  buffered in-memory.
1207. #  See also: MappingKernelManager.buffer_offline_messages
1208. # c.AsyncMappingKernelManager.buffer_offline_messages = True
1210. ## Whether to consider culling kernels which are busy.
1211. #  See also: MappingKernelManager.cull_busy
1212. # c.AsyncMappingKernelManager.cull_busy = False
1214. ## Whether to consider culling kernels which have one or more connections.
1215. #  See also: MappingKernelManager.cull_connected
1216. # c.AsyncMappingKernelManager.cull_connected = False
1218. ## Timeout (in seconds) after which a kernel is considered idle and ready to be
1219. #  culled.
1220. #  See also: MappingKernelManager.cull_idle_timeout
1221. # c.AsyncMappingKernelManager.cull_idle_timeout = 0
1223. ## The interval (in seconds) on which to check for idle kernels exceeding the
1224. #  cull timeout value.
1225. #  See also: MappingKernelManager.cull_interval
1226. # c.AsyncMappingKernelManager.cull_interval = 300
1228. ## The name of the default kernel to start
1229. #  See also: MultiKernelManager.default_kernel_name
1230. # c.AsyncMappingKernelManager.default_kernel_name = 'python3'
1232. ## Timeout for giving up on a kernel (in seconds).
1233. #  See also: MappingKernelManager.kernel_info_timeout
1234. # c.AsyncMappingKernelManager.kernel_info_timeout = 60
1236. ## The kernel manager class.  This is configurable to allow
1237. #  See also: AsyncMultiKernelManager.kernel_manager_class
1238. # c.AsyncMappingKernelManager.kernel_manager_class = 'jupyter_client.ioloop.AsyncIOLoopKernelManager'
1240. #  See also: MappingKernelManager.root_dir
1241. # c.AsyncMappingKernelManager.root_dir = ''
1243. ## Share a single zmq.Context to talk to all my kernels
1244. #  See also: MultiKernelManager.shared_context
1245. # c.AsyncMappingKernelManager.shared_context = True
1247. ## Whether to make kernels available before the process has started.  The
1248. #  See also: AsyncMultiKernelManager.use_pending_kernels
1249. # c.AsyncMappingKernelManager.use_pending_kernels = False
1251. #------------------------------------------------------------------------------
1252. # GatewayKernelManager(AsyncMappingKernelManager) configuration
1253. #------------------------------------------------------------------------------
1254. ## Kernel manager that supports remote kernels hosted by Jupyter Kernel or
1255. #  Enterprise Gateway.
1257. ## White list of allowed kernel message types.
1258. #  See also: MappingKernelManager.allowed_message_types
1259. # c.GatewayKernelManager.allowed_message_types = []
1261. ## Whether messages from kernels whose frontends have disconnected should be
1262. #  buffered in-memory.
1263. #  See also: MappingKernelManager.buffer_offline_messages
1264. # c.GatewayKernelManager.buffer_offline_messages = True
1266. ## Whether to consider culling kernels which are busy.
1267. #  See also: MappingKernelManager.cull_busy
1268. # c.GatewayKernelManager.cull_busy = False
1270. ## Whether to consider culling kernels which have one or more connections.
1271. #  See also: MappingKernelManager.cull_connected
1272. # c.GatewayKernelManager.cull_connected = False
1274. ## Timeout (in seconds) after which a kernel is considered idle and ready to be
1275. #  culled.
1276. #  See also: MappingKernelManager.cull_idle_timeout
1277. # c.GatewayKernelManager.cull_idle_timeout = 0
1279. ## The interval (in seconds) on which to check for idle kernels exceeding the
1280. #  cull timeout value.
1281. #  See also: MappingKernelManager.cull_interval
1282. # c.GatewayKernelManager.cull_interval = 300
1284. ## The name of the default kernel to start
1285. #  See also: MultiKernelManager.default_kernel_name
1286. # c.GatewayKernelManager.default_kernel_name = 'python3'
1288. ## Timeout for giving up on a kernel (in seconds).
1289. #  See also: MappingKernelManager.kernel_info_timeout
1290. # c.GatewayKernelManager.kernel_info_timeout = 60
1292. ## The kernel manager class.  This is configurable to allow
1293. #  See also: AsyncMultiKernelManager.kernel_manager_class
1294. # c.GatewayKernelManager.kernel_manager_class = 'jupyter_client.ioloop.AsyncIOLoopKernelManager'
1296. #  See also: MappingKernelManager.root_dir
1297. # c.GatewayKernelManager.root_dir = ''
1299. ## Share a single zmq.Context to talk to all my kernels
1300. #  See also: MultiKernelManager.shared_context
1301. # c.GatewayKernelManager.shared_context = True
1303. ## Whether to make kernels available before the process has started.  The
1304. #  See also: AsyncMultiKernelManager.use_pending_kernels
1305. # c.GatewayKernelManager.use_pending_kernels = False
1307. #------------------------------------------------------------------------------
1308. # GatewayKernelSpecManager(KernelSpecManager) configuration
1309. #------------------------------------------------------------------------------
1310. ## List of allowed kernel names.
1311. #  See also: KernelSpecManager.allowed_kernelspecs
1312. # c.GatewayKernelSpecManager.allowed_kernelspecs = set()
1314. ## If there is no Python kernelspec registered and the IPython
1315. #  See also: KernelSpecManager.ensure_native_kernel
1316. # c.GatewayKernelSpecManager.ensure_native_kernel = True
1318. ## The kernel spec class.  This is configurable to allow
1319. #  See also: KernelSpecManager.kernel_spec_class
1320. # c.GatewayKernelSpecManager.kernel_spec_class = 'jupyter_client.kernelspec.KernelSpec'
1322. ## Deprecated, use `KernelSpecManager.allowed_kernelspecs`
1323. #  See also: KernelSpecManager.whitelist
1324. # c.GatewayKernelSpecManager.whitelist = set()
1326. #------------------------------------------------------------------------------
1327. # GatewayClient(SingletonConfigurable) configuration
1328. #------------------------------------------------------------------------------
1329. ## This class manages the configuration.  It's its own singleton class so that we
1330. #         can share these values across all objects.  It also contains some helper methods
1331. #         to build request arguments out of the various config options.
1333. ## The authorization token used in the HTTP headers.  (JUPYTER_GATEWAY_AUTH_TOKEN
1334. #  env var)
1335. #  Default: None
1336. # c.GatewayClient.auth_token = None
1338. ## The filename of CA certificates or None to use defaults.
1339. #  (JUPYTER_GATEWAY_CA_CERTS env var)
1340. #  Default: None
1341. # c.GatewayClient.ca_certs = None
1343. ## The filename for client SSL certificate, if any.  (JUPYTER_GATEWAY_CLIENT_CERT
1344. #  env var)
1345. #  Default: None
1346. # c.GatewayClient.client_cert = None
1348. ## The filename for client SSL key, if any.  (JUPYTER_GATEWAY_CLIENT_KEY env var)
1349. #  Default: None
1350. # c.GatewayClient.client_key = None
1352. ## The time allowed for HTTP connection establishment with the Gateway server.
1353. #          (JUPYTER_GATEWAY_CONNECT_TIMEOUT env var)
1354. #  Default: 40.0
1355. # c.GatewayClient.connect_timeout = 40.0
1357. ## A comma-separated list of environment variable names that will be included, along with
1358. #           their values, in the kernel startup request.  The corresponding `env_whitelist` configuration
1359. #           value must also be set on the Gateway server - since that configuration value indicates which
1360. #           environmental values to make available to the kernel. (JUPYTER_GATEWAY_ENV_WHITELIST env var)
1361. #  Default: ''
1362. # c.GatewayClient.env_whitelist = ''
1364. ## The time allowed for HTTP reconnection with the Gateway server for the first time.
1365. #                  Next will be JUPYTER_GATEWAY_RETRY_INTERVAL multiplied by two in factor of numbers of retries
1366. #                  but less than JUPYTER_GATEWAY_RETRY_INTERVAL_MAX.
1367. #                  (JUPYTER_GATEWAY_RETRY_INTERVAL env var)
1368. #  Default: 1.0
1369. # c.GatewayClient.gateway_retry_interval = 1.0
1371. ## The maximum time allowed for HTTP reconnection retry with the Gateway server.
1372. #                  (JUPYTER_GATEWAY_RETRY_INTERVAL_MAX env var)
1373. #  Default: 30.0
1374. # c.GatewayClient.gateway_retry_interval_max = 30.0
1376. ## The maximum retries allowed for HTTP reconnection with the Gateway server.
1377. #                  (JUPYTER_GATEWAY_RETRY_MAX env var)
1378. #  Default: 5
1379. # c.GatewayClient.gateway_retry_max = 5
1381. ## Additional HTTP headers to pass on the request.  This value will be converted to a dict.
1382. #            (JUPYTER_GATEWAY_HEADERS env var)
1383. #  Default: '{}'
1384. # c.GatewayClient.headers = '{}'
1386. ## The password for HTTP authentication.  (JUPYTER_GATEWAY_HTTP_PWD env var)
1387. #  Default: None
1388. # c.GatewayClient.http_pwd = None
1390. ## The username for HTTP authentication. (JUPYTER_GATEWAY_HTTP_USER env var)
1391. #  Default: None
1392. # c.GatewayClient.http_user = None
1394. ## The gateway API endpoint for accessing kernel resources
1395. #  (JUPYTER_GATEWAY_KERNELS_ENDPOINT env var)
1396. #  Default: '/api/kernels'
1397. # c.GatewayClient.kernels_endpoint = '/api/kernels'
1399. ## The gateway API endpoint for accessing kernelspecs
1400. #  (JUPYTER_GATEWAY_KERNELSPECS_ENDPOINT env var)
1401. #  Default: '/api/kernelspecs'
1402. # c.GatewayClient.kernelspecs_endpoint = '/api/kernelspecs'
1404. ## The gateway endpoint for accessing kernelspecs resources
1405. #              (JUPYTER_GATEWAY_KERNELSPECS_RESOURCE_ENDPOINT env var)
1406. #  Default: '/kernelspecs'
1407. # c.GatewayClient.kernelspecs_resource_endpoint = '/kernelspecs'
1409. ## The time allowed for HTTP request completion. (JUPYTER_GATEWAY_REQUEST_TIMEOUT
1410. #  env var)
1411. #  Default: 40.0
1412. # c.GatewayClient.request_timeout = 40.0
1414. ## The url of the Kernel or Enterprise Gateway server where
1415. #          kernel specifications are defined and kernel management takes place.
1416. #          If defined, this Notebook server acts as a proxy for all kernel
1417. #          management and kernel specification retrieval.  (JUPYTER_GATEWAY_URL env var)
1418. #  Default: None
1419. # c.GatewayClient.url = None
1421. ## For HTTPS requests, determines if server's certificate should be validated or not.
1422. #          (JUPYTER_GATEWAY_VALIDATE_CERT env var)
1423. #  Default: True
1424. # c.GatewayClient.validate_cert = True
1426. ## The websocket url of the Kernel or Enterprise Gateway server.  If not provided, this value
1427. #          will correspond to the value of the Gateway url with 'ws' in place of 'http'.  (JUPYTER_GATEWAY_WS_URL env var)
1428. #  Default: None
1429. # c.GatewayClient.ws_url = None
1431. #------------------------------------------------------------------------------
1432. # TerminalManager(LoggingConfigurable) configuration
1433. #------------------------------------------------------------------------------
1434. ##
1436. ## Timeout (in seconds) in which a terminal has been inactive and ready to be culled.
1437. #          Values of 0 or lower disable culling.
1438. #  Default: 0
1439. # c.TerminalManager.cull_inactive_timeout = 0
1441. ## The interval (in seconds) on which to check for terminals exceeding the
1442. #  inactive timeout value.
1443. #  Default: 300
1444. # c.TerminalManager.cull_interval = 300

复制代码

来源:https://www.cnblogs.com/yourxiong/p/17692123.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！