Self-host the open-source frontend

The get.chat Web App (the inbox frontend) is open source. You can run your own copy of the UI — branded however you like — pointed at your get.chat instance’s Integration API.

The Integration API itself is served by your hosted get.chat instance; what you self-host here is the frontend, which talks to that API.

Run with Docker (quickest)

Ready-to-use images are published in the GitLab Container Registry. Pass configuration through an env file:

# create docker.env from the template in the repo, then:
docker run --rm --env-file=docker.env -p 127.0.0.1:8080:80 \
  registry.gitlab.com/get.chat/web-app:<app-version>

Check the registry for the exact image path and available tags.

Run from source

Prerequisites: Node.js (LTS) and PNPM.

  1. Create public/config.json from the provided public/config.json.tmpl. Key fields:

    • API base URL — defaults to /api/v1/; point it at your get.chat instance.

    • APP_SENTRY_DSN — error reporting (optional; can be disabled).

    • APP_GOOGLE_MAPS_API_KEY — needed to render location messages.

  2. Start it:

    pnpm install
    pnpm start      # dev server on http://localhost:3000
    pnpm build      # production bundle
    

Branding via environment variables

Override the look without touching code:

Variable

Purpose

REACT_APP_TITLE

Page / application title.

REACT_APP_LOGO_URL

Application logo.

REACT_APP_LOGO_BLACK_URL

Logo variant shown on the loading screen.

REACT_APP_FAVICON_URL

Page favicon.

REACT_APP_MANIFEST_URL

manifest.json URL (PWA metadata).

REACT_APP_ERROR_HELP_LINK_URL / _TEXT

Help link shown if the app fails to load.

Next

Once it’s running, embed it and tweak it per-session with query parameters — see Embed & white-label the inbox.