Changing the logos of Zero to JupyterHub k8s

abdelrahmanai · August 12, 2020, 9:40am

Is there any documentation on customizing / changing the jupyter logos?

Thanks
Abd

manics · August 13, 2020, 6:31pm

There’s a config option c.JupyterHub.logo_file:
https://jupyterhub.readthedocs.io/en/stable/api/app.html#jupyterhub.app.JupyterHub.logo_file

(note there may be a minor CSS bug which means you need to scroll up to see that property, otherwise it’s hidden behind the page menu header).

abdelrahmanai · August 18, 2020, 11:45am

Thank you for the response.
Just for me to understand, currently I am using helm to install jupyterhub. How would I put the image on the image/pod?
Edit: or can I use a hyperlink to direct me to the logo file?

sluna · October 16, 2020, 10:09am

Hi @manics

I am trying to achieve the same. Would this be a correct config to use in config.yml?

hub:
extraConfig:
myConfig: |
c.JupyterHub.logo_file: “URL”

manics · October 18, 2020, 5:32pm

Looking at the source code:

github.com

jupyterhub/jupyterhub/blob/998c18df42d01097859b215c278b0da2902b088e/jupyterhub/app.py#L639-L648


logo_file = Unicode(
    '',
    help="Specify path to a logo image to override the Jupyter logo in the banner.",
).tag(config=True)

@default('logo_file')
def _logo_file_default(self):
    return os.path.join(
        self.data_files_path, 'static', 'images', 'jupyterhub-80.png'
    )

github.com

jupyterhub/jupyterhub/blob/998c18df42d01097859b215c278b0da2902b088e/jupyterhub/app.py#L1367


h = []
# load handlers from the authenticator
h.extend(self.authenticator.get_handlers(self))
# set default handlers
h.extend(handlers.default_handlers)
h.extend(apihandlers.default_handlers)

# add any user configurable handlers.
h.extend(self.extra_handlers)

h.append((r'/logo', LogoHandler, {'path': self.logo_file}))
h.append((r'/api/(.*)', apihandlers.base.API404))

self.handlers = self.add_url_prefix(self.hub_prefix, h)
# some extra handlers, outside hub_prefix
self.handlers.extend(
    [
        # add trailing / to ``/user|services/:name`
        (
            r"%s(user|services)/([^/]+)" % self.base_url,
            handlers.AddSlashHandler,

So only a local file is supported.

sluna · October 19, 2020, 10:07am

Thanks @manics

I tried it without success.

Are there any restrictions w.r.t file format, permissions or path?

I am using a png file located in the same folder where I have the config.yml.

Many thanks,
Sebastian

manics · October 21, 2020, 8:42am

I’m not sure. Have you tried enabling debug logging?

sluna · October 21, 2020, 11:21am

Thanks @manics

Enabling debug didn’t show useful information in this regard.

On the other hand, I found the following relevant issue:

Until a better solution is found the following worked for me:
hub:
extraConfig:
logoConfig: |
import urllib.request
urllib.request.urlretrieve(“URL”, “mylogo.png”)
c.JupyterHub.logo_file = ‘/srv/jupyterhub/mylogo.png’

Many thanks for your help!

Topic		Replies	Views
Customizing JupyterHub on Kubernetes Zero to JupyterHub on Kubernetes	36	13474	January 13, 2025
Zero to Jupyter Helm Chart .py files Zero to JupyterHub on Kubernetes	1	353	February 20, 2021
Jupyterhub kubernetes JupyterHub	2	459	January 14, 2023
Custom logo and custom footer Zero to JupyterHub on Kubernetes jupyterlab , jupyterhub , how-to	2	46	December 17, 2024
Change the UI for the JupyterHub in k8s JupyterHub	4	838	February 19, 2023

Changing the logos of Zero to JupyterHub k8s

Related topics