Guidance on styling/branding interfaces: jupyterhub, jupyterlab, etc.

Update by Erik - 2021-10-25

It would be good to have some references to how to brand/style the JupyterHub websites (/hub prefixed urls), as well as some notes on the complexity about styling the user facing UIs (/user prefixed urls). But we probably should not go further than some pointers as it would be too hard to maintain detailed steps in this repo. Currently we have https://github.com/jupyterhub/the-littlest-jupyterhub/issues/434#issuecomment-574159678 that represents the best available documentation notes within this github repo.

Relevant things to cover

• Permissions on JupyterHub templates, the JupyterHub process will read them, so that would be the jupyterhub user right?
• Link out to docs on how to configure JupyterHub’s look/templates
• Link out to docs on how to configure user interfaces running in the user server if there are such docs for JupyterLab or the classical Notebook interface etc.

Related issues

• #220 (closed in favor of this)
• #512 (closed in favor of this)
• #669 (closed in favor of this)

Original issue

I’ve had jupyterhub deployed before with a login template using the “c.JupyterHub.template_paths=[‘.’]” in jupyterhub_config.py. But how does one use templates in TLHJ?

[vsisl]

I just got started with TLJH (and JupyterHub in general). I would appreciate guidance on some very simple customisation. Basically all I wish for is to:

1. Customize the jupyterhub brand to something like ‘MyCompanyHub’
2. Customize the logo

I believe that most users would be happy with this level of customisation.

Not sure how difficult it would be to create and maintain such instructions.

Thanks for all your development effort. Setting up TLJH was amazingly simple and it works like a charm!

[GeorgianaElena]

Hey @Adrast, @flavionc 🌞 Sorry for the late reply.

The way to customize TLJH bits that are not supported through tljh-config is using custom jupyterhub_config.py snippets

1. Create a .py file (with whatever name you want) in /opt/tljh/config/jupyterhub_config.d. In that file add:

   c.JupyterHub.template_paths=['/absolute/path/to/your/template']
   

   For example, if your custom login template (login.html - extending templates/login.html) is in the same directory as your config snippet, it would look something like this:

   c.JupyterHub.template_paths=['/opt/tljh/config/jupyterhub_config.d']
   

2. Load the new configuration:

    sudo tljh-config reload