Branding

Chat reads its branding from site.config.js, which it serves next to the web app at /site.config.js. Every visitor can read the file, so never put a secret in it.

Change the branding

1. 1

   Copy the file

   Start from the file the image ships, so you keep every setting and its comment:

   mkdir -p branding/assets
   docker run --rm --entrypoint cat <chat-image> /app/web/site.config.js > branding/site.config.js
   

2. 2

   Edit it

   Change the name, text, logo and links. Put your images in branding/assets and refer to them as ./assets/custom/<file>.

3. 3

   Mount it over the default

   Mount the file at /app/web/site.config.js and the images at /app/web/assets/custom, as shown below. Later edits need only a page reload.

kubectl -n obleth-chat create configmap chat-branding \
  --from-file=site.config.js=branding/site.config.js \
  --from-file=branding/assets/

# In the Deployment's pod spec
volumes:
  - name: branding
    configMap: { name: chat-branding }
containers:
  - name: chat
    volumeMounts:
      - { name: branding, mountPath: /app/web/site.config.js, subPath: site.config.js, readOnly: true }
      - { name: branding, mountPath: /app/web/assets/custom, readOnly: true }

What you can set

Text is plain text: \n makes a line break, and '' hides an optional line.

window.OblethChatConfig = {
  siteName: 'Research Computing Chat',
  logo: { light: './assets/custom/logo-dark-ink.svg', dark: './assets/custom/logo-white.svg', alt: '' },
  login: {
    title: 'Sign in to Chat',
    help: 'No account yet?',
    helpLink: { label: 'Request one', url: 'https://rc.example.edu/accounts' },
  },
  links: [
    { label: 'Help', url: 'https://rc.example.edu/help' },
    { label: 'Acceptable use', url: 'https://rc.example.edu/aup' },
  ],
};

Settings you leave out keep their defaults.