Function Client (self-host)
Branding
The product's name, the assistant's name and the links the client offers
come from one file, packages/shared-types/brand.json. To rename your
deployment, edit that file and rebuild:
The server reads the file when it starts, and the web client is built from it, so both change together.
Settings
| Key | What it sets |
|---|---|
appName | The product's name: the page title, the sign-in screen, emails and the assistant's instructions. Its first letter is the icon (below). |
assistantName | The built-in assistant's name in chat. |
tagline | The page title's second half. |
description | The page's meta description. |
productUrl | Your product's website, used in emails and link previews. |
docsUrl | Your documentation, linked from the Shopify app's embedded page and the GitHub integration. |
supportEmail | The address the client offers for help, for example on the subscription screen. |
desktopDownloadUrl | A desktop app download page, shown in Settings and on the update screen. |
skillsInstallUrl | The install script the "connect an agent" screen offers. |
iosAppUrl, androidAppUrl | Where phone visitors are sent from the web client. |
Leave a link or address empty and the client hides whatever offers it.
The icon
There is no logo setting. The favicon, the assistant's avatar and the icon
on every page the server serves are your appName's first letter on a
rounded square.