Gotify

Send push notifications to your browsers and devices.

Choose your deployment and the way you want to use Selfhost. The instructions below follow that choice.

Deployment Use Selfhost with

Set up Gotify

Editable Compose files in your own directory.

Sign in using the generated administrator password from .env.
Create an application token in Gotify for each notification producer.

selfhost app --directory ./gotify init gotify

Initialization writes portable files and does not start the app. Review compose.yaml, the private .env and any files in files/, then start it:

selfhost app --directory ./gotify start

No Selfhost dashboard or background service is needed. You can also start these files directly:

cd gotify
docker compose -f compose.yaml up -d

Connect an existing installation

Use Existing apps → Link an app in the dashboard, or the CLI’s existing-app commands. Choose Gotify, its URL and, optionally, its exact Docker container on a connected server.

Save existing.json with your app URL. Add server_id and container for container inspection and actions.

{
  "profile": "gotify",
  "name": "Gotify",
  "url": "https://app.example.com"
}

selfhost existing link --file existing.json
selfhost existing list
selfhost existing inspect EXISTING_ID

Linking enables the existing-app profile’s supported inspection and actions. It does not import Compose or attach the new-deployment settings and onboarding profiles described below.

Existing app commands, permissions and unlinking

Before configuring integrations

OIDC setup preserves local login and uses standard provider discovery.
Database placement includes PostgreSQL, MySQL and MariaDB using app-specific connection settings. Select a fresh or already migrated database before first start; changing the engine does not convert existing data.
MySQL and MariaDB TLS uses server certificate verification whenever enabled. A source configured as require therefore still needs a certificate trusted by the app; private CA certificates must be installed in the app trust store.
Application tokens are distinct from user/client tokens. Selfhost does not distribute an administrator token to other apps.

Gotify integrations

Compose service: gotify. These operations use the profile saved when this deployment is created.

Native settings

Changes use the app’s Compose environment. Unrelated settings are preserved.

Supported fields (6)

Allow registration registration: stringChoices: true, false
HTTPS-only cookies secure-cookie: Enable after the public URL uses HTTPS. stringChoices: true, false
OpenID Connect oidc-enabled: stringChoices: true, false
OIDC issuer URL oidc-issuer: string
OIDC client secret oidc-secret: secret · advanced
Create accounts on first OIDC login oidc-registration: stringChoices: true, false

Save a JSON map of the field IDs you want to change as changes.json. Replace FIELD_ID with an ID from the supported fields above, and use its declared value type. Review the plan and replace REVIEWED_REVISION with the revision it returns.

{
  "FIELD_ID": "YOUR_VALUE"
}

selfhost app --directory ./gotify config gotify
selfhost app --directory ./gotify plan gotify changes.json
selfhost app --directory ./gotify apply gotify changes.json --revision REVIEWED_REVISION

Saved changes need service recreation to become active. Existing interpolated environment values stay under your control in .env or Compose.

Identity provider login

Selfhost can register a client with a supported provider and configure this app. Callback path: /auth/oidc/callback.

No administrator role is assigned by Selfhost. Check the app’s first-login policy and retain a local recovery account.

Save connection.json and replace the URLs. Supply SELFHOST_IDP_TOKEN privately in your shell.

{
  "provider": "zitadel",
  "issuer": "https://identity.example.com",
  "app_url": "https://app.example.com",
  "name": "Gotify"
}

selfhost app --directory ./gotify connect-account gotify connection.json
selfhost app --directory ./gotify connect-plan gotify connection.json
selfhost app --directory ./gotify connect gotify connection.json --revision REVIEWED_REVISION

Test sign-in in a separate browser session. HTTPS domains and HTTP loopback development origins are supported by Selfhost; the chosen app and provider must also accept the resulting callback. Provider permissions, localhost and recovery.

Database placement

This recipe supports postgres, mysql, mariadb. Workspace projects can choose a dedicated database, a shared source with a separate database and account, or an existing external database before their first start.

postgres adapter TLS modes: disable, require, verify-full. Use a private network for connections with TLS disabled.
mysql adapter TLS modes: disable, require, verify-full. Use a private network for connections with TLS disabled.
mariadb adapter TLS modes: disable, require, verify-full. Use a private network for connections with TLS disabled.

Standalone directories use the generated Compose and environment files directly. Configure the database there before first start. Selfhost’s source provisioning commands belong to workspace projects and are optional.

Database setup, CLI commands and backups

App configuration reference

Versions and updates

This deployment uses the following images. Existing projects retain their saved recipe and images. A new catalogue version does not silently update them.

gotify: gotify/server:3.1.1

3.1.1 gotify/server:3.1.1
Local Docker startup, generated administrator login, volume persistence and standalone update workflow verified. Isolated 3.1.0 to 3.1.1 upgrade passed HTTP health, persistent data marker and declared recipe action checks.

Review compatibility and back up app data before an update. Choose an image version and review the change.

Keep control of your setup

Selfhost remains optional. Your app runs using ordinary Compose files, its own settings and persistent data. Keep the Compose project name and volumes to preserve storage. Configuration exports and setting backups do not include application data.

Standalone CLI guide · Backups and removal · Gotify documentation