ui Documentation

1. Project Overview & Quickstart (gotify/ui) Copy Chapter

ui

A set of beautifully-designed, accessible components and a code distribution platform. Works with your favorite frameworks. Open Source. Open Code.

Repository Details Copy Section

• Repository: gotify/ui
• GitHub Stars: ⭐ 121,204
• Primary Language: TypeScript

Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.

2. Official Technical Reference & Guides (gotify/website) Copy Chapter

File: README.md Copy Chapter

gotify/website [](https://github.com/gotify/website/actions/workflows/main.yml)

-> https://gotify.net

Run locally Copy Chapter

$ yarn install
$ yarn dev

File: docs/apache.md Copy Chapter

Apache reverse proxy

Here are configuration examples for setting up Apache as a reverse proxy for Gotify.

The following modules are required:

• mod_proxy
• mod_proxy_wstunnel
• mod_proxy_http

Proxy requests Copy Chapter

<VirtualHost *:80>
    ServerName domain.tld

    Keepalive On

    # The proxy must preserve the host because Gotify verifies the host with the origin
    # for WebSocket connections
    ProxyPreserveHost On

    # Proxy WebSocket requests to /stream
    ProxyPass "/stream" ws://127.0.0.1:GOTIFY_PORT/stream retry=0 timeout=60

    # Proxy all other requests to /
    ProxyPass "/" http://127.0.0.1:GOTIFY_PORT/ retry=0 timeout=5

    ProxyPassReverse / http://127.0.0.1:GOTIFY_PORT/
</VirtualHost>

Proxy requests with sub path Copy Chapter

<VirtualHost *:80>
    ServerName domain.tld
    Keepalive On

    Redirect 301 "/gotify" "/gotify/"

    # The proxy must preserve the host because Gotify verifies the host with the origin
    # for WebSocket connections
    ProxyPreserveHost On

    # Proxy WebSocket requests to /stream
    ProxyPass "/gotify/stream" ws://127.0.0.1:GOTIFY_PORT/stream retry=0 timeout=60

    # Proxy all other requests to /
    ProxyPass "/gotify/" http://127.0.0.1:GOTIFY_PORT/ retry=0 timeout=5
    #                 ^- !!trailing slash is required!!

    ProxyPassReverse /gotify/ http://127.0.0.1:GOTIFY_PORT/
</VirtualHost>

Troubleshooting Copy Chapter

With some additional Apache configuration, the ProxyPass for the /stream endpoint may not work correctly.
The request fails with 400 Bad Request and Gotify logs the following error.

Error #01: websocket: the client is not using the websocket protocol: 'upgrade' token not found in 'Connection' header

To fix this issue, add the following rewrite rule to your virtual host config:

RewriteEngine  on
RewriteCond %{HTTP:Connection} upgrade [NC]
RewriteCond %{HTTP:Upgrade} websocket [NC]
RewriteRule /gotify/stream(.*) ws://127.0.0.1:GOTIFY_PORT/stream$1 [P,L]

File: docs/build.md Copy Chapter

Build Gotify

1. Setup development environment

2. Build the UI

   bash Copy

   $ (cd ui && yarn build)

3. Build the Go Binary

   It is recommended to build gotify/server via the gotify/build docker images.
   This ensures that plugins will be compatible with the built binary because the same build environment is used.

   Set the LD_FLAGS with meta information like the version or the commit:

   bash Copy

   $ export LD_FLAGS="-w -s -X main.Version=$(git describe --tags | cut -c 2-) -X main.BuildDate=$(date "+%F-%T") -X main.Commit=$(git rev-parse --verify HEAD) -X main.Mode=prod";

   Execute gotify/server Makefile tasks to build gotify/server.

   bash Copy

   # builds all supported platforms
   $ make build
   # builds a specific platform
   $ make build-linux-amd64
   $ make build-linux-arm-7
   $ make build-linux-arm64
   $ make build-linux-386
   $ make build-linux-riscv64
   $ make build-windows-amd64
   $ make build-windows-386

   If you do not want to use the docker images you can build gotify/server like this:

   bash Copy

   $ go build -ldflags="$LD_FLAGS" -o gotify-server

   The project has a CGO reference (because of sqlite3), therefore a CGO cross compiler is needed when compiling for
   other platforms (the gotify/build docker images already contain the needed cross compilers).

   bash Copy

   $ CGO_ENABLED=1 CC=${CROSS_GCC} CXX=${CROSS_G++} GOOS=${TARGET_GOOS} GOARCH=${TARGET_GOARCH} \
       go build -ldflags="$LD_FLAGS" -o gotify-server

File: docs/caddy.md Copy Chapter

Caddy 2 reverse proxy

Here are configuration examples for setting up Caddy as a reverse proxy for Gotify.

As a standalone domain Copy Chapter

Here is a sample config file if your Gotify instance runs on port 1245.

gotify.example.com {
  # Set the port to the one you are using in Gotify
  # WebSocket support, proxy headers, etc. are enabled by default
  reverse_proxy localhost:1245
}

Caddy automatically obtains TLS certificates from Let's Encrypt for your domain. If you want to explicitly disable TLS, prefix your server name with http://.

At a subpath Copy Chapter

Here is the equivalent of the sample config above but running at a subpath.

example.com {
  route /gotify/* {
    uri strip_prefix /gotify
    # Set the port to the one you are using in Gotify
    reverse_proxy localhost:1245
  }
  redir /gotify /gotify/
}

File: docs/dev-server-and-tests.md Copy Chapter

Servers and Tests

Start development servers Copy Chapter

Backend Copy Section

The backend embeds the built UI, so build it first.

$ (cd ui && yarn build)

Start the server in development mode.

$ go run .

UI Copy Section

Start the UI development server.

Commands must be executed inside the ui directory.

$ yarn start

Open http://localhost:5173 inside your favorite browser.

The UI development server proxies API requests to a Gotify server running on
localhost:80. Create a gotify-server.env in the gotify/server repository
containing GOTIFY_SERVER_PORT=8080 to change the port.

Update Swagger spec Copy Chapter

The gotify/server REST-API is documented via Swagger. The Swagger definition is generated from source code comments
(example comment).

After changing such a comment, run the following command to update the Swagger definition.

$ make update-swagger

Tests Copy Chapter

Execute Backend Tests Copy Section

Run tests

$ go test ./...

Run Tests with Coverage

$ make test-coverage
$ go tool cover -html=coverage.txt # get a HTML coverage report

Execute UI (end2end) Tests Copy Section

Build the UI because the end2end tests run against the production build.
(This needs to be done after every change in the UI)

$ (cd ui && yarn build)

Now execute the tests with yarn.

$ (cd ui && yarn test)

Execute Static Checks Copy Section

The following command checks the formatting, runs linters like golangci-lint and eslint, and verifies that the Swagger spec is up to date.

$ make check

File: docs/dev-setup.md Copy Chapter

Setup Environment

Gotify requires:

• Go 1.25 or newer
• Node 24 or newer
• Yarn 1.9 or newer

Clone sources Copy Chapter

Clone the gotify/server source from git:

$ git clone https://github.com/gotify/server.git && cd server

Setup Backend Copy Chapter

Install the development tools (needed for generating the Swagger spec):

$ make download-tools

Setup UI Copy Chapter

Commands must be executed inside the ui directory.

Download dependencies with yarn.

$ yarn

File: docs/first-login.md Copy Chapter

First Login

After setting up gotify/server you can log in to the WebUI. On first launch an initial admin account is created. If you have not overridden the defaults in the configuration, use username admin and password admin.

Once logged in you can create your own user(s) and, if desired, delete the default account (after creating another administrator account). You can also remove any username/password overrides from your configuration, they are only used to create this initial account.

If you keep the default account, be sure to change its password so it is not admin!

File: docs/haproxy.md Copy Chapter

HAProxy reverse proxy

Here are configuration examples for setting up HAProxy as a reverse proxy for Gotify.

Proxy requests Copy Chapter

frontend www
    bind 0.0.0.0:80
    default_backend backend_gotify
    timeout client 60s
    timeout client-fin 30s

backend backend_gotify
    server  backend01       127.0.0.1:GOTIFY_PORT  check
    timeout connect 10s
    timeout server 60s

File: docs/index.md Copy Chapter

Intro

This is the documentation of gotify/server. Let's start with some definitions:

A client is a device or program that receives messages and can manage clients, applications and messages. A client cannot send messages.

An application is a device or program that can only send messages.

Users can only manage (view/edit/delete) the clients and applications they created, including messages sent by those applications.

A message has the following attributes: content, title, creation date, application id and priority.