jupyter_lab_config.py 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113
  1. # Configuration file for lab.
  2. #------------------------------------------------------------------------------
  3. # Application(SingletonConfigurable) configuration
  4. #------------------------------------------------------------------------------
  5. ## This is an application.
  6. ## The date format used by logging formatters for %(asctime)s
  7. # Default: '%Y-%m-%d %H:%M:%S'
  8. # c.Application.log_datefmt = '%Y-%m-%d %H:%M:%S'
  9. ## The Logging format template
  10. # Default: '[%(name)s]%(highlevel)s %(message)s'
  11. # c.Application.log_format = '[%(name)s]%(highlevel)s %(message)s'
  12. ## Set the log level by value or name.
  13. # Choices: any of [0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']
  14. # Default: 30
  15. # c.Application.log_level = 30
  16. ## Configure additional log handlers.
  17. #
  18. # The default stderr logs handler is configured by the log_level, log_datefmt
  19. # and log_format settings.
  20. #
  21. # This configuration can be used to configure additional handlers (e.g. to
  22. # output the log to a file) or for finer control over the default handlers.
  23. #
  24. # If provided this should be a logging configuration dictionary, for more
  25. # information see:
  26. # https://docs.python.org/3/library/logging.config.html#logging-config-
  27. # dictschema
  28. #
  29. # This dictionary is merged with the base logging configuration which defines
  30. # the following:
  31. #
  32. # * A logging formatter intended for interactive use called
  33. # ``console``.
  34. # * A logging handler that writes to stderr called
  35. # ``console`` which uses the formatter ``console``.
  36. # * A logger with the name of this application set to ``DEBUG``
  37. # level.
  38. #
  39. # This example adds a new handler that writes to a file:
  40. #
  41. # .. code-block:: python
  42. #
  43. # c.Application.logging_configuration = {
  44. # 'handlers': {
  45. # 'file': {
  46. # 'class': 'logging.FileHandler',
  47. # 'level': 'DEBUG',
  48. # 'filename': '<path/to/file>',
  49. # }
  50. # },
  51. # 'loggers': {
  52. # '<application-name>': {
  53. # 'level': 'DEBUG',
  54. # # NOTE: if you don't list the default "console"
  55. # # handler here then it will be disabled
  56. # 'handlers': ['console', 'file'],
  57. # },
  58. # }
  59. # }
  60. # Default: {}
  61. # c.Application.logging_config = {}
  62. ## Instead of starting the Application, dump configuration to stdout
  63. # Default: False
  64. # c.Application.show_config = False
  65. ## Instead of starting the Application, dump configuration to stdout (as JSON)
  66. # Default: False
  67. # c.Application.show_config_json = False
  68. #------------------------------------------------------------------------------
  69. # JupyterApp(Application) configuration
  70. #------------------------------------------------------------------------------
  71. ## Base class for Jupyter applications
  72. ## Answer yes to any prompts.
  73. # Default: False
  74. # c.JupyterApp.answer_yes = False
  75. ## Full path of a config file.
  76. # Default: ''
  77. # c.JupyterApp.config_file = ''
  78. ## Specify a config file to load.
  79. # Default: ''
  80. # c.JupyterApp.config_file_name = ''
  81. ## Generate default config file.
  82. # Default: False
  83. # c.JupyterApp.generate_config = False
  84. ## The date format used by logging formatters for %(asctime)s
  85. # See also: Application.log_datefmt
  86. # c.JupyterApp.log_datefmt = '%Y-%m-%d %H:%M:%S'
  87. ## The Logging format template
  88. # See also: Application.log_format
  89. # c.JupyterApp.log_format = '[%(name)s]%(highlevel)s %(message)s'
  90. ## Set the log level by value or name.
  91. # See also: Application.log_level
  92. # c.JupyterApp.log_level = 30
  93. ##
  94. # See also: Application.logging_config
  95. # c.JupyterApp.logging_config = {}
  96. ## Instead of starting the Application, dump configuration to stdout
  97. # See also: Application.show_config
  98. # c.JupyterApp.show_config = False
  99. ## Instead of starting the Application, dump configuration to stdout (as JSON)
  100. # See also: Application.show_config_json
  101. # c.JupyterApp.show_config_json = False
  102. #------------------------------------------------------------------------------
  103. # ExtensionApp(JupyterApp) configuration
  104. #------------------------------------------------------------------------------
  105. ## Base class for configurable Jupyter Server Extension Applications.
  106. #
  107. # ExtensionApp subclasses can be initialized two ways:
  108. # 1. Extension is listed as a jpserver_extension, and ServerApp calls
  109. # its load_jupyter_server_extension classmethod. This is the
  110. # classic way of loading a server extension.
  111. # 2. Extension is launched directly by calling its `launch_instance`
  112. # class method. This method can be set as a entry_point in
  113. # the extensions setup.py
  114. ## Answer yes to any prompts.
  115. # See also: JupyterApp.answer_yes
  116. # c.ExtensionApp.answer_yes = False
  117. ## Full path of a config file.
  118. # See also: JupyterApp.config_file
  119. # c.ExtensionApp.config_file = ''
  120. ## Specify a config file to load.
  121. # See also: JupyterApp.config_file_name
  122. # c.ExtensionApp.config_file_name = ''
  123. # Default: ''
  124. # c.ExtensionApp.default_url = ''
  125. ## Generate default config file.
  126. # See also: JupyterApp.generate_config
  127. # c.ExtensionApp.generate_config = False
  128. ## Handlers appended to the server.
  129. # Default: []
  130. # c.ExtensionApp.handlers = []
  131. ## The date format used by logging formatters for %(asctime)s
  132. # See also: Application.log_datefmt
  133. # c.ExtensionApp.log_datefmt = '%Y-%m-%d %H:%M:%S'
  134. ## The Logging format template
  135. # See also: Application.log_format
  136. # c.ExtensionApp.log_format = '[%(name)s]%(highlevel)s %(message)s'
  137. ## Set the log level by value or name.
  138. # See also: Application.log_level
  139. # c.ExtensionApp.log_level = 30
  140. ##
  141. # See also: Application.logging_config
  142. # c.ExtensionApp.logging_config = {}
  143. ## Whether to open in a browser after starting.
  144. # The specific browser used is platform dependent and
  145. # determined by the python standard library `webbrowser`
  146. # module, unless it is overridden using the --browser
  147. # (ServerApp.browser) configuration option.
  148. # Default: False
  149. # c.ExtensionApp.open_browser = False
  150. ## Settings that will passed to the server.
  151. # Default: {}
  152. # c.ExtensionApp.settings = {}
  153. ## Instead of starting the Application, dump configuration to stdout
  154. # See also: Application.show_config
  155. # c.ExtensionApp.show_config = False
  156. ## Instead of starting the Application, dump configuration to stdout (as JSON)
  157. # See also: Application.show_config_json
  158. # c.ExtensionApp.show_config_json = False
  159. ## paths to search for serving static files.
  160. #
  161. # This allows adding javascript/css to be available from the notebook server machine,
  162. # or overriding individual files in the IPython
  163. # Default: []
  164. # c.ExtensionApp.static_paths = []
  165. ## Url where the static assets for the extension are served.
  166. # Default: ''
  167. # c.ExtensionApp.static_url_prefix = ''
  168. ## Paths to search for serving jinja templates.
  169. #
  170. # Can be used to override templates from notebook.templates.
  171. # Default: []
  172. # c.ExtensionApp.template_paths = []
  173. #------------------------------------------------------------------------------
  174. # LabServerApp(ExtensionApp) configuration
  175. #------------------------------------------------------------------------------
  176. ## A Lab Server Application that runs out-of-the-box
  177. ## "A list of comma-separated URIs to get the allowed extensions list
  178. #
  179. # .. versionchanged:: 2.0.0
  180. # `LabServerApp.whitetlist_uris` renamed to `allowed_extensions_uris`
  181. # Default: ''
  182. # c.LabServerApp.allowed_extensions_uris = ''
  183. ## Answer yes to any prompts.
  184. # See also: JupyterApp.answer_yes
  185. # c.LabServerApp.answer_yes = False
  186. ## The application settings directory.
  187. # Default: ''
  188. # c.LabServerApp.app_settings_dir = ''
  189. ## The url path for the application.
  190. # Default: '/lab'
  191. # c.LabServerApp.app_url = '/lab'
  192. ## Deprecated, use `LabServerApp.blocked_extensions_uris`
  193. # Default: ''
  194. # c.LabServerApp.blacklist_uris = ''
  195. ## A list of comma-separated URIs to get the blocked extensions list
  196. #
  197. # .. versionchanged:: 2.0.0
  198. # `LabServerApp.blacklist_uris` renamed to `blocked_extensions_uris`
  199. # Default: ''
  200. # c.LabServerApp.blocked_extensions_uris = ''
  201. ## Whether to cache files on the server. This should be `True` except in dev
  202. # mode.
  203. # Default: True
  204. # c.LabServerApp.cache_files = True
  205. ## Full path of a config file.
  206. # See also: JupyterApp.config_file
  207. # c.LabServerApp.config_file = ''
  208. ## Specify a config file to load.
  209. # See also: JupyterApp.config_file_name
  210. # c.LabServerApp.config_file_name = ''
  211. ## Extra paths to look for federated JupyterLab extensions
  212. # Default: []
  213. # c.LabServerApp.extra_labextensions_path = []
  214. ## Generate default config file.
  215. # See also: JupyterApp.generate_config
  216. # c.LabServerApp.generate_config = False
  217. ## Handlers appended to the server.
  218. # See also: ExtensionApp.handlers
  219. # c.LabServerApp.handlers = []
  220. ## Options to pass to the jinja2 environment for this
  221. # Default: {}
  222. # c.LabServerApp.jinja2_options = {}
  223. ## The standard paths to look in for federated JupyterLab extensions
  224. # Default: []
  225. # c.LabServerApp.labextensions_path = []
  226. ## The url for federated JupyterLab extensions
  227. # Default: ''
  228. # c.LabServerApp.labextensions_url = ''
  229. ## The interval delay in seconds to refresh the lists
  230. # Default: 3600
  231. # c.LabServerApp.listings_refresh_seconds = 3600
  232. ## The optional kwargs to use for the listings HTTP requests as
  233. # described on https://2.python-requests.org/en/v2.7.0/api/#requests.request
  234. # Default: {}
  235. # c.LabServerApp.listings_request_options = {}
  236. ## The listings url.
  237. # Default: ''
  238. # c.LabServerApp.listings_url = ''
  239. ## The date format used by logging formatters for %(asctime)s
  240. # See also: Application.log_datefmt
  241. # c.LabServerApp.log_datefmt = '%Y-%m-%d %H:%M:%S'
  242. ## The Logging format template
  243. # See also: Application.log_format
  244. # c.LabServerApp.log_format = '[%(name)s]%(highlevel)s %(message)s'
  245. ## Set the log level by value or name.
  246. # See also: Application.log_level
  247. # c.LabServerApp.log_level = 30
  248. ##
  249. # See also: Application.logging_config
  250. # c.LabServerApp.logging_config = {}
  251. ## Whether a notebook should start a kernel automatically.
  252. # Default: True
  253. # c.LabServerApp.notebook_starts_kernel = True
  254. ## Whether to open in a browser after starting.
  255. # See also: ExtensionApp.open_browser
  256. # c.LabServerApp.open_browser = False
  257. ## The optional location of the settings schemas directory. If given, a handler
  258. # will be added for settings.
  259. # Default: ''
  260. # c.LabServerApp.schemas_dir = ''
  261. ## Settings that will passed to the server.
  262. # See also: ExtensionApp.settings
  263. # c.LabServerApp.settings = {}
  264. ## The url path of the settings handler.
  265. # Default: ''
  266. # c.LabServerApp.settings_url = ''
  267. ## Instead of starting the Application, dump configuration to stdout
  268. # See also: Application.show_config
  269. # c.LabServerApp.show_config = False
  270. ## Instead of starting the Application, dump configuration to stdout (as JSON)
  271. # See also: Application.show_config_json
  272. # c.LabServerApp.show_config_json = False
  273. ## The optional location of local static files. If given, a static file handler
  274. # will be added.
  275. # Default: ''
  276. # c.LabServerApp.static_dir = ''
  277. ## paths to search for serving static files.
  278. # See also: ExtensionApp.static_paths
  279. # c.LabServerApp.static_paths = []
  280. ## Url where the static assets for the extension are served.
  281. # See also: ExtensionApp.static_url_prefix
  282. # c.LabServerApp.static_url_prefix = ''
  283. ## Paths to search for serving jinja templates.
  284. # See also: ExtensionApp.template_paths
  285. # c.LabServerApp.template_paths = []
  286. ## The application templates directory.
  287. # Default: ''
  288. # c.LabServerApp.templates_dir = ''
  289. ## The optional location of the themes directory. If given, a handler will be
  290. # added for themes.
  291. # Default: ''
  292. # c.LabServerApp.themes_dir = ''
  293. ## The theme url.
  294. # Default: ''
  295. # c.LabServerApp.themes_url = ''
  296. ## The url path of the translations handler.
  297. # Default: ''
  298. # c.LabServerApp.translations_api_url = ''
  299. ## The url path of the tree handler.
  300. # Default: ''
  301. # c.LabServerApp.tree_url = ''
  302. ## The optional location of the user settings directory.
  303. # Default: ''
  304. # c.LabServerApp.user_settings_dir = ''
  305. ## Deprecated, use `LabServerApp.allowed_extensions_uris`
  306. # Default: ''
  307. # c.LabServerApp.whitelist_uris = ''
  308. ## The url path of the workspaces API.
  309. # Default: ''
  310. # c.LabServerApp.workspaces_api_url = ''
  311. ## The optional location of the saved workspaces directory. If given, a handler
  312. # will be added for workspaces.
  313. # Default: ''
  314. # c.LabServerApp.workspaces_dir = ''
  315. #------------------------------------------------------------------------------
  316. # LabApp(LabServerApp) configuration
  317. #------------------------------------------------------------------------------
  318. ##
  319. # See also: LabServerApp.allowed_extensions_uris
  320. # c.LabApp.allowed_extensions_uris = ''
  321. ## Answer yes to any prompts.
  322. # See also: JupyterApp.answer_yes
  323. # c.LabApp.answer_yes = False
  324. ## The app directory to launch JupyterLab from.
  325. # Default: None
  326. # c.LabApp.app_dir = None
  327. ## The application settings directory.
  328. # Default: ''
  329. # c.LabApp.app_settings_dir = ''
  330. ## The url path for the application.
  331. # Default: '/lab'
  332. # c.LabApp.app_url = '/lab'
  333. ## Deprecated, use `LabServerApp.blocked_extensions_uris`
  334. # See also: LabServerApp.blacklist_uris
  335. # c.LabApp.blacklist_uris = ''
  336. ##
  337. # See also: LabServerApp.blocked_extensions_uris
  338. # c.LabApp.blocked_extensions_uris = ''
  339. ## Whether to cache files on the server. This should be `True` except in dev
  340. # mode.
  341. # Default: True
  342. # c.LabApp.cache_files = True
  343. ## Whether to enable collaborative mode (experimental).
  344. # Default: False
  345. # c.LabApp.collaborative = False
  346. ## Full path of a config file.
  347. # See also: JupyterApp.config_file
  348. # c.LabApp.config_file = ''
  349. ## Specify a config file to load.
  350. # See also: JupyterApp.config_file_name
  351. # c.LabApp.config_file_name = ''
  352. ## Whether to start the app in core mode. In this mode, JupyterLab
  353. # will run using the JavaScript assets that are within the installed
  354. # JupyterLab Python package. In core mode, third party extensions are disabled.
  355. # The `--dev-mode` flag is an alias to this to be used when the Python package
  356. # itself is installed in development mode (`pip install -e .`).
  357. # Default: False
  358. # c.LabApp.core_mode = False
  359. ## The default URL to redirect to from `/`
  360. # Default: '/lab'
  361. # c.LabApp.default_url = '/lab'
  362. ## Whether to start the app in dev mode. Uses the unpublished local
  363. # JavaScript packages in the `dev_mode` folder. In this case JupyterLab will
  364. # show a red stripe at the top of the page. It can only be used if JupyterLab
  365. # is installed as `pip install -e .`.
  366. # Default: False
  367. # c.LabApp.dev_mode = False
  368. ## Whether to expose the global app instance to browser via window.jupyterlab
  369. # Default: False
  370. # c.LabApp.expose_app_in_browser = False
  371. ## Whether to load prebuilt extensions in dev mode. This may be
  372. # useful to run and test prebuilt extensions in development installs of
  373. # JupyterLab. APIs in a JupyterLab development install may be
  374. # incompatible with published packages, so prebuilt extensions compiled
  375. # against published packages may not work correctly.
  376. # Default: False
  377. # c.LabApp.extensions_in_dev_mode = False
  378. ## Extra paths to look for federated JupyterLab extensions
  379. # Default: []
  380. # c.LabApp.extra_labextensions_path = []
  381. ## Generate default config file.
  382. # See also: JupyterApp.generate_config
  383. # c.LabApp.generate_config = False
  384. ## Handlers appended to the server.
  385. # See also: ExtensionApp.handlers
  386. # c.LabApp.handlers = []
  387. ## Options to pass to the jinja2 environment for this
  388. # Default: {}
  389. # c.LabApp.jinja2_options = {}
  390. ## The standard paths to look in for federated JupyterLab extensions
  391. # Default: []
  392. # c.LabApp.labextensions_path = []
  393. ## The url for federated JupyterLab extensions
  394. # Default: ''
  395. # c.LabApp.labextensions_url = ''
  396. ## The interval delay in seconds to refresh the lists
  397. # See also: LabServerApp.listings_refresh_seconds
  398. # c.LabApp.listings_refresh_seconds = 3600
  399. ## The optional kwargs to use for the listings HTTP requests as
  400. # described on https://2.python-requests.org/en/v2.7.0/api/#requests.request
  401. # See also: LabServerApp.listings_request_options
  402. # c.LabApp.listings_request_options = {}
  403. ## The listings url.
  404. # Default: ''
  405. # c.LabApp.listings_url = ''
  406. ## The date format used by logging formatters for %(asctime)s
  407. # See also: Application.log_datefmt
  408. # c.LabApp.log_datefmt = '%Y-%m-%d %H:%M:%S'
  409. ## The Logging format template
  410. # See also: Application.log_format
  411. # c.LabApp.log_format = '[%(name)s]%(highlevel)s %(message)s'
  412. ## Set the log level by value or name.
  413. # See also: Application.log_level
  414. # c.LabApp.log_level = 30
  415. ##
  416. # See also: Application.logging_config
  417. # c.LabApp.logging_config = {}
  418. ## Whether a notebook should start a kernel automatically.
  419. # Default: True
  420. # c.LabApp.notebook_starts_kernel = True
  421. ## Whether to open in a browser after starting.
  422. # See also: ExtensionApp.open_browser
  423. # c.LabApp.open_browser = False
  424. ## The override url for static lab assets, typically a CDN.
  425. # Default: ''
  426. # c.LabApp.override_static_url = ''
  427. ## The override url for static lab theme assets, typically a CDN.
  428. # Default: ''
  429. # c.LabApp.override_theme_url = ''
  430. ## The optional location of the settings schemas directory. If given, a handler
  431. # will be added for settings.
  432. # Default: ''
  433. # c.LabApp.schemas_dir = ''
  434. ## Settings that will passed to the server.
  435. # See also: ExtensionApp.settings
  436. # c.LabApp.settings = {}
  437. ## The url path of the settings handler.
  438. # Default: ''
  439. # c.LabApp.settings_url = ''
  440. ## Instead of starting the Application, dump configuration to stdout
  441. # See also: Application.show_config
  442. # c.LabApp.show_config = False
  443. ## Instead of starting the Application, dump configuration to stdout (as JSON)
  444. # See also: Application.show_config_json
  445. # c.LabApp.show_config_json = False
  446. ## Splice source packages into app directory.
  447. # Default: False
  448. # c.LabApp.splice_source = False
  449. ## The optional location of local static files. If given, a static file handler
  450. # will be added.
  451. # Default: ''
  452. # c.LabApp.static_dir = ''
  453. ## paths to search for serving static files.
  454. # See also: ExtensionApp.static_paths
  455. # c.LabApp.static_paths = []
  456. ## Url where the static assets for the extension are served.
  457. # See also: ExtensionApp.static_url_prefix
  458. # c.LabApp.static_url_prefix = ''
  459. ## Paths to search for serving jinja templates.
  460. # See also: ExtensionApp.template_paths
  461. # c.LabApp.template_paths = []
  462. ## The application templates directory.
  463. # Default: ''
  464. # c.LabApp.templates_dir = ''
  465. ## The optional location of the themes directory. If given, a handler will be
  466. # added for themes.
  467. # Default: ''
  468. # c.LabApp.themes_dir = ''
  469. ## The theme url.
  470. # Default: ''
  471. # c.LabApp.themes_url = ''
  472. ## The url path of the translations handler.
  473. # Default: ''
  474. # c.LabApp.translations_api_url = ''
  475. ## The url path of the tree handler.
  476. # Default: ''
  477. # c.LabApp.tree_url = ''
  478. ## The directory for user settings.
  479. # Default: '/home/heruji/.jupyter/lab/user-settings'
  480. # c.LabApp.user_settings_dir = '/home/heruji/.jupyter/lab/user-settings'
  481. ## Whether to serve the app in watch mode
  482. # Default: False
  483. # c.LabApp.watch = False
  484. ## Deprecated, use `LabServerApp.allowed_extensions_uris`
  485. # See also: LabServerApp.whitelist_uris
  486. # c.LabApp.whitelist_uris = ''
  487. ## The url path of the workspaces API.
  488. # Default: ''
  489. # c.LabApp.workspaces_api_url = ''
  490. ## The directory for workspaces
  491. # Default: '/home/heruji/.jupyter/lab/workspaces'
  492. # c.LabApp.workspaces_dir = '/home/heruji/.jupyter/lab/workspaces'
  493. #------------------------------------------------------------------------------
  494. # ServerApp(JupyterApp) configuration
  495. #------------------------------------------------------------------------------
  496. ## Set the Access-Control-Allow-Credentials: true header
  497. # Default: False
  498. # c.ServerApp.allow_credentials = False
  499. ## Set the Access-Control-Allow-Origin header
  500. #
  501. # Use '*' to allow any origin to access your server.
  502. #
  503. # Takes precedence over allow_origin_pat.
  504. # Default: ''
  505. # c.ServerApp.allow_origin = ''
  506. ## Use a regular expression for the Access-Control-Allow-Origin header
  507. #
  508. # Requests from an origin matching the expression will get replies with:
  509. #
  510. # Access-Control-Allow-Origin: origin
  511. #
  512. # where `origin` is the origin of the request.
  513. #
  514. # Ignored if allow_origin is set.
  515. # Default: ''
  516. # c.ServerApp.allow_origin_pat = ''
  517. ## Allow password to be changed at login for the Jupyter server.
  518. #
  519. # While logging in with a token, the Jupyter server UI will give the opportunity to
  520. # the user to enter a new password at the same time that will replace
  521. # the token login mechanism.
  522. #
  523. # This can be set to false to prevent changing password from
  524. # the UI/API.
  525. # Default: True
  526. # c.ServerApp.allow_password_change = True
  527. ## Allow requests where the Host header doesn't point to a local server
  528. #
  529. # By default, requests get a 403 forbidden response if the 'Host' header
  530. # shows that the browser thinks it's on a non-local domain.
  531. # Setting this option to True disables this check.
  532. #
  533. # This protects against 'DNS rebinding' attacks, where a remote web server
  534. # serves you a page and then changes its DNS to send later requests to a
  535. # local IP, bypassing same-origin checks.
  536. #
  537. # Local IP addresses (such as 127.0.0.1 and ::1) are allowed as local,
  538. # along with hostnames configured in local_hostnames.
  539. # Default: False
  540. # c.ServerApp.allow_remote_access = False
  541. ## Whether to allow the user to run the server as root.
  542. # Default: False
  543. # c.ServerApp.allow_root = False
  544. ## Answer yes to any prompts.
  545. # See also: JupyterApp.answer_yes
  546. # c.ServerApp.answer_yes = False
  547. ## "
  548. # Require authentication to access prometheus metrics.
  549. # Default: True
  550. # c.ServerApp.authenticate_prometheus = True
  551. ## The authorizer class to use.
  552. # Default: 'jupyter_server.auth.authorizer.AllowAllAuthorizer'
  553. # c.ServerApp.authorizer_class = 'jupyter_server.auth.authorizer.AllowAllAuthorizer'
  554. ## Reload the webapp when changes are made to any Python src files.
  555. # Default: False
  556. # c.ServerApp.autoreload = False
  557. ## The base URL for the Jupyter server.
  558. #
  559. # Leading and trailing slashes can be omitted,
  560. # and will automatically be added.
  561. # Default: '/'
  562. # c.ServerApp.base_url = '/'
  563. ## Specify what command to use to invoke a web
  564. # browser when starting the server. If not specified, the
  565. # default browser will be determined by the `webbrowser`
  566. # standard library module, which allows setting of the
  567. # BROWSER environment variable to override it.
  568. # Default: ''
  569. # c.ServerApp.browser = ''
  570. ## The full path to an SSL/TLS certificate file.
  571. # Default: ''
  572. # c.ServerApp.certfile = ''
  573. ## The full path to a certificate authority certificate for SSL/TLS client
  574. # authentication.
  575. # Default: ''
  576. # c.ServerApp.client_ca = ''
  577. ## Full path of a config file.
  578. # See also: JupyterApp.config_file
  579. # c.ServerApp.config_file = ''
  580. ## Specify a config file to load.
  581. # See also: JupyterApp.config_file_name
  582. # c.ServerApp.config_file_name = ''
  583. ## The config manager class to use
  584. # Default: 'jupyter_server.services.config.manager.ConfigManager'
  585. # c.ServerApp.config_manager_class = 'jupyter_server.services.config.manager.ConfigManager'
  586. ## The content manager class to use.
  587. # Default: 'jupyter_server.services.contents.largefilemanager.LargeFileManager'
  588. #c.ServerApp.contents_manager_class = 'hdfscm.HDFSContentsManager'
  589. ## Extra keyword arguments to pass to `set_secure_cookie`. See tornado's
  590. # set_secure_cookie docs for details.
  591. # Default: {}
  592. # c.ServerApp.cookie_options = {}
  593. ## The random bytes used to secure cookies.
  594. # By default this is a new random number every time you start the server.
  595. # Set it to a value in a config file to enable logins to persist across server sessions.
  596. #
  597. # Note: Cookie secrets should be kept private, do not share config files with
  598. # cookie_secret stored in plaintext (you can read the value from a file).
  599. # Default: b''
  600. # c.ServerApp.cookie_secret = b''
  601. ## The file where the cookie secret is stored.
  602. # Default: ''
  603. # c.ServerApp.cookie_secret_file = ''
  604. ## Override URL shown to users.
  605. #
  606. # Replace actual URL, including protocol, address, port and base URL,
  607. # with the given value when displaying URL to the users. Do not change
  608. # the actual connection URL. If authentication token is enabled, the
  609. # token is added to the custom URL automatically.
  610. #
  611. # This option is intended to be used when the URL to display to the user
  612. # cannot be determined reliably by the Jupyter server (proxified
  613. # or containerized setups for example).
  614. # Default: ''
  615. # c.ServerApp.custom_display_url = ''
  616. ## The default URL to redirect to from `/`
  617. # Default: '/'
  618. # c.ServerApp.default_url = '/'
  619. ## Disable cross-site-request-forgery protection
  620. #
  621. # Jupyter notebook 4.3.1 introduces protection from cross-site request forgeries,
  622. # requiring API requests to either:
  623. #
  624. # - originate from pages served by this server (validated with XSRF cookie and token), or
  625. # - authenticate with a token
  626. #
  627. # Some anonymous compute resources still desire the ability to run code,
  628. # completely without authentication.
  629. # These services can disable all authentication and security checks,
  630. # with the full knowledge of what that implies.
  631. # Default: False
  632. # c.ServerApp.disable_check_xsrf = False
  633. ## handlers that should be loaded at higher priority than the default services
  634. # Default: []
  635. # c.ServerApp.extra_services = []
  636. ## Extra paths to search for serving static files.
  637. #
  638. # This allows adding javascript/css to be available from the Jupyter server machine,
  639. # or overriding individual files in the IPython
  640. # Default: []
  641. # c.ServerApp.extra_static_paths = []
  642. ## Extra paths to search for serving jinja templates.
  643. #
  644. # Can be used to override templates from jupyter_server.templates.
  645. # Default: []
  646. # c.ServerApp.extra_template_paths = []
  647. ## Open the named file when the application is launched.
  648. # Default: ''
  649. # c.ServerApp.file_to_run = ''
  650. ## The URL prefix where files are opened directly.
  651. # Default: 'notebooks'
  652. # c.ServerApp.file_url_prefix = 'notebooks'
  653. ## Generate default config file.
  654. # See also: JupyterApp.generate_config
  655. # c.ServerApp.generate_config = False
  656. ## Extra keyword arguments to pass to `get_secure_cookie`. See tornado's
  657. # get_secure_cookie docs for details.
  658. # Default: {}
  659. # c.ServerApp.get_secure_cookie_kwargs = {}
  660. ## (bytes/sec)
  661. # Maximum rate at which stream output can be sent on iopub before they are
  662. # limited.
  663. # Default: 1000000
  664. # c.ServerApp.iopub_data_rate_limit = 1000000
  665. ## (msgs/sec)
  666. # Maximum rate at which messages can be sent on iopub before they are
  667. # limited.
  668. # Default: 1000
  669. # c.ServerApp.iopub_msg_rate_limit = 1000
  670. ## The IP address the Jupyter server will listen on.
  671. # Default: 'localhost'
  672. # c.ServerApp.ip = 'localhost'
  673. ## Supply extra arguments that will be passed to Jinja environment.
  674. # Default: {}
  675. # c.ServerApp.jinja_environment_options = {}
  676. ## Extra variables to supply to jinja templates when rendering.
  677. # Default: {}
  678. # c.ServerApp.jinja_template_vars = {}
  679. ## Dict of Python modules to load as Jupyter server extensions.Entry values can
  680. # be used to enable and disable the loading ofthe extensions. The extensions
  681. # will be loaded in alphabetical order.
  682. # Default: {}
  683. # c.ServerApp.jpserver_extensions = {}
  684. ## The kernel manager class to use.
  685. # Default: 'jupyter_server.services.kernels.kernelmanager.AsyncMappingKernelManager'
  686. # c.ServerApp.kernel_manager_class = 'jupyter_server.services.kernels.kernelmanager.AsyncMappingKernelManager'
  687. ## The kernel spec manager class to use. Should be a subclass of
  688. # `jupyter_client.kernelspec.KernelSpecManager`.
  689. #
  690. # The Api of KernelSpecManager is provisional and might change without warning
  691. # between this version of Jupyter and the next stable one.
  692. # Default: 'jupyter_client.kernelspec.KernelSpecManager'
  693. # c.ServerApp.kernel_spec_manager_class = 'jupyter_client.kernelspec.KernelSpecManager'
  694. ## Preferred kernel message protocol over websocket to use (default: None). If an
  695. # empty string is passed, select the legacy protocol. If None, the selected
  696. # protocol will depend on what the front-end supports (usually the most recent
  697. # protocol supported by the back-end and the front-end).
  698. # Default: None
  699. # c.ServerApp.kernel_ws_protocol = None
  700. ## The full path to a private key file for usage with SSL/TLS.
  701. # Default: ''
  702. # c.ServerApp.keyfile = ''
  703. ## Whether to limit the rate of IOPub messages (default: True). If True, use
  704. # iopub_msg_rate_limit, iopub_data_rate_limit and/or rate_limit_window to tune
  705. # the rate.
  706. # Default: True
  707. # c.ServerApp.limit_rate = True
  708. ## Hostnames to allow as local when allow_remote_access is False.
  709. #
  710. # Local IP addresses (such as 127.0.0.1 and ::1) are automatically accepted
  711. # as local as well.
  712. # Default: ['localhost']
  713. # c.ServerApp.local_hostnames = ['localhost']
  714. ## The date format used by logging formatters for %(asctime)s
  715. # See also: Application.log_datefmt
  716. # c.ServerApp.log_datefmt = '%Y-%m-%d %H:%M:%S'
  717. ## The Logging format template
  718. # See also: Application.log_format
  719. # c.ServerApp.log_format = '[%(name)s]%(highlevel)s %(message)s'
  720. ## Set the log level by value or name.
  721. # See also: Application.log_level
  722. # c.ServerApp.log_level = 30
  723. ##
  724. # See also: Application.logging_config
  725. # c.ServerApp.logging_config = {}
  726. ## The login handler class to use.
  727. # Default: 'jupyter_server.auth.login.LoginHandler'
  728. # c.ServerApp.login_handler_class = 'jupyter_server.auth.login.LoginHandler'
  729. ## The logout handler class to use.
  730. # Default: 'jupyter_server.auth.logout.LogoutHandler'
  731. # c.ServerApp.logout_handler_class = 'jupyter_server.auth.logout.LogoutHandler'
  732. ## Sets the maximum allowed size of the client request body, specified in the
  733. # Content-Length request header field. If the size in a request exceeds the
  734. # configured value, a malformed HTTP message is returned to the client.
  735. #
  736. # Note: max_body_size is applied even in streaming mode.
  737. # Default: 536870912
  738. # c.ServerApp.max_body_size = 536870912
  739. ## Gets or sets the maximum amount of memory, in bytes, that is allocated for use
  740. # by the buffer manager.
  741. # Default: 536870912
  742. # c.ServerApp.max_buffer_size = 536870912
  743. ## Gets or sets a lower bound on the open file handles process resource limit.
  744. # This may need to be increased if you run into an OSError: [Errno 24] Too many
  745. # open files. This is not applicable when running on Windows.
  746. # Default: 0
  747. # c.ServerApp.min_open_files_limit = 0
  748. ## DEPRECATED, use root_dir.
  749. # Default: ''
  750. # c.ServerApp.notebook_dir = ''
  751. ## Whether to open in a browser after starting.
  752. # The specific browser used is platform dependent and
  753. # determined by the python standard library `webbrowser`
  754. # module, unless it is overridden using the --browser
  755. # (ServerApp.browser) configuration option.
  756. # Default: False
  757. # c.ServerApp.open_browser = False
  758. ## Hashed password to use for web authentication.
  759. #
  760. # To generate, type in a python/IPython shell:
  761. #
  762. # from jupyter_server.auth import passwd; passwd()
  763. #
  764. # The string should be of the form type:salt:hashed-
  765. # password.
  766. # Default: ''
  767. # c.ServerApp.password = ''
  768. ## Forces users to use a password for the Jupyter server.
  769. # This is useful in a multi user environment, for instance when
  770. # everybody in the LAN can access each other's machine through ssh.
  771. #
  772. # In such a case, serving on localhost is not secure since
  773. # any user can connect to the Jupyter server via ssh.
  774. # Default: False
  775. # c.ServerApp.password_required = False
  776. ## The port the server will listen on (env: JUPYTER_PORT).
  777. # Default: 0
  778. # c.ServerApp.port = 0
  779. ## The number of additional ports to try if the specified port is not available
  780. # (env: JUPYTER_PORT_RETRIES).
  781. # Default: 50
  782. # c.ServerApp.port_retries = 50
  783. ## Preferred starting directory to use for notebooks and kernels.
  784. # Default: ''
  785. #c.ServerApp.preferred_dir = '/'
  786. ## DISABLED: use %pylab or %matplotlib in the notebook to enable matplotlib.
  787. # Default: 'disabled'
  788. # c.ServerApp.pylab = 'disabled'
  789. ## If True, display controls to shut down the Jupyter server, such as menu items
  790. # or buttons.
  791. # Default: True
  792. # c.ServerApp.quit_button = True
  793. ## (sec) Time window used to
  794. # check the message and data rate limits.
  795. # Default: 3
  796. # c.ServerApp.rate_limit_window = 3
  797. ## Reraise exceptions encountered loading server extensions?
  798. # Default: False
  799. # c.ServerApp.reraise_server_extension_failures = False
  800. ## The directory to use for notebooks and kernels.
  801. # Default: ''
  802. # c.ServerApp.root_dir = ''
  803. ## The session manager class to use.
  804. # Default: 'jupyter_server.services.sessions.sessionmanager.SessionManager'
  805. # c.ServerApp.session_manager_class = 'jupyter_server.services.sessions.sessionmanager.SessionManager'
  806. ## Instead of starting the Application, dump configuration to stdout
  807. # See also: Application.show_config
  808. # c.ServerApp.show_config = False
  809. ## Instead of starting the Application, dump configuration to stdout (as JSON)
  810. # See also: Application.show_config_json
  811. # c.ServerApp.show_config_json = False
  812. ## Shut down the server after N seconds with no kernels or terminals running and
  813. # no activity. This can be used together with culling idle kernels
  814. # (MappingKernelManager.cull_idle_timeout) to shutdown the Jupyter server when
  815. # it's not in use. This is not precisely timed: it may shut down up to a minute
  816. # later. 0 (the default) disables this automatic shutdown.
  817. # Default: 0
  818. # c.ServerApp.shutdown_no_activity_timeout = 0
  819. ## The UNIX socket the Jupyter server will listen on.
  820. # Default: ''
  821. # c.ServerApp.sock = ''
  822. ## The permissions mode for UNIX socket creation (default: 0600).
  823. # Default: '0600'
  824. # c.ServerApp.sock_mode = '0600'
  825. ## Supply SSL options for the tornado HTTPServer.
  826. # See the tornado docs for details.
  827. # Default: {}
  828. # c.ServerApp.ssl_options = {}
  829. ## Supply overrides for terminado. Currently only supports "shell_command".
  830. # Default: {}
  831. # c.ServerApp.terminado_settings = {}
  832. ## Set to False to disable terminals.
  833. #
  834. # This does *not* make the server more secure by itself.
  835. # Anything the user can in a terminal, they can also do in a notebook.
  836. #
  837. # Terminals may also be automatically disabled if the terminado package
  838. # is not available.
  839. # Default: True
  840. # c.ServerApp.terminals_enabled = True
  841. ## Token used for authenticating first-time connections to the server.
  842. #
  843. # The token can be read from the file referenced by JUPYTER_TOKEN_FILE or set directly
  844. # with the JUPYTER_TOKEN environment variable.
  845. #
  846. # When no password is enabled,
  847. # the default is to generate a new, random token.
  848. #
  849. # Setting to an empty string disables authentication altogether, which
  850. # is NOT RECOMMENDED.
  851. # Default: '<generated>'
  852. # c.ServerApp.token = '<generated>'
  853. ## Supply overrides for the tornado.web.Application that the Jupyter server uses.
  854. # Default: {}
  855. # c.ServerApp.tornado_settings = {}
  856. ## Whether to trust or not X-Scheme/X-Forwarded-Proto and X-Real-Ip/X-Forwarded-
  857. # For headerssent by the upstream reverse proxy. Necessary if the proxy handles
  858. # SSL
  859. # Default: False
  860. # c.ServerApp.trust_xheaders = False
  861. ## Disable launching browser by redirect file
  862. # For versions of notebook > 5.7.2, a security feature measure was added that
  863. # prevented the authentication token used to launch the browser from being visible.
  864. # This feature makes it difficult for other users on a multi-user system from
  865. # running code in your Jupyter session as you.
  866. # However, some environments (like Windows Subsystem for Linux (WSL) and Chromebooks),
  867. # launching a browser using a redirect file can lead the browser failing to load.
  868. # This is because of the difference in file structures/paths between the runtime and
  869. # the browser.
  870. #
  871. # Disabling this setting to False will disable this behavior, allowing the browser
  872. # to launch by using a URL and visible token (as before).
  873. # Default: True
  874. # c.ServerApp.use_redirect_file = True
  875. ## Specify where to open the server on startup. This is the
  876. # `new` argument passed to the standard library method `webbrowser.open`.
  877. # The behaviour is not guaranteed, but depends on browser support. Valid
  878. # values are:
  879. #
  880. # - 2 opens a new tab,
  881. # - 1 opens a new window,
  882. # - 0 opens in an existing window.
  883. #
  884. # See the `webbrowser.open` documentation for details.
  885. # Default: 2
  886. # c.ServerApp.webbrowser_open_new = 2
  887. ## Set the tornado compression options for websocket connections.
  888. #
  889. # This value will be returned from
  890. # :meth:`WebSocketHandler.get_compression_options`. None (default) will disable
  891. # compression. A dict (even an empty one) will enable compression.
  892. #
  893. # See the tornado docs for WebSocketHandler.get_compression_options for details.
  894. # Default: None
  895. # c.ServerApp.websocket_compression_options = None
  896. ## The base URL for websockets,
  897. # if it differs from the HTTP server (hint: it almost certainly doesn't).
  898. #
  899. # Should be in the form of an HTTP origin: ws[s]://hostname[:port]
  900. # Default: ''
  901. # c.ServerApp.websocket_url = ''