From c5fc1a70d7c140b0017caa07fa21168378d6ab7b Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Wed, 1 Aug 2018 02:52:40 -0700 Subject: [PATCH] Add docs for escape hatch --- docs/index.rst | 1 + docs/topic/escape-hatch.rst | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 docs/topic/escape-hatch.rst diff --git a/docs/index.rst b/docs/index.rst index 5c54c13..0dbe514 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -83,6 +83,7 @@ Topic guides provide in-depth explanations of specific topics. topic/installer-actions topic/tljh-config topic/authenticator-configuration + topic/escape-hatch Troubleshooting diff --git a/docs/topic/escape-hatch.rst b/docs/topic/escape-hatch.rst new file mode 100644 index 0000000..bb42bc5 --- /dev/null +++ b/docs/topic/escape-hatch.rst @@ -0,0 +1,16 @@ +.. _topic/escape-hatch: + +======================================== +Custom ``jupyterhub_config.py`` snippets +======================================== + +Sometimes you need to customize TLJH in ways that are not officially supported. +We provide an easy escape hatch for those cases with a ``jupyterhub_conf.d`` +directory that lets you load multiple ``jupyterhub_config.py`` snippets for +your configuration. + +Any files in ``/opt/tljh/jupyterhub_config.d`` that end in ``.py`` will be +loaded in alphabetical order as python files to provide configuration for +JupyterHub. Any config that can go in a regular ``jupyterhub_config.py`` +file is valid in these files. They will be loaded *after* any of the config +options specified by TLJH are loaded. \ No newline at end of file