HYPHAby S33D
Documentation › Administer

Self-hosting

The same software as hypha.s33d.fr, on your machine, free and without limits. Your metrics, logs and traces stay in your PostgreSQL database.

Requirements

Install

mkdir hypha && cd hypha
curl -fsSLO https://hypha.s33d.fr/auto-hebergement/docker-compose.yml
curl -fsSL https://hypha.s33d.fr/auto-hebergement/env.example -o .env

Fill in .env. The four required values:

HYPHA_DB_PASSWORD=     # openssl rand -hex 24
HYPHA_PUBLIC_URL=      # https://hypha.your-domain.com
HYPHA_ADMIN_PASSWORD=  # password of the "admin" account
HYPHA_SECRET=          # openssl rand -hex 32

Install the certificate, then start:

mkdir certs
cp /path/fullchain.pem /path/privkey.pem certs/
docker compose up -d

On first start, HYPHA creates the database, the organisation (HYPHA_ORG_NAME), the administration account (HYPHA_ADMIN_LOGIN, admin by default) and six base monitors. Open HYPHA_PUBLIC_URL and sign in.

Then install the agents from Settings › Install the agent: the command downloads the agent from your server and links it to it (HYPHA_URL).

What the kit contains

ServiceRole
dbPostgreSQL 18; data in the hypha-db volume
migrateupdates the schema, then stops
apiHYPHA API and agent intake
workermonitors, synthetic tests, notifications, database partitions
nginxinterface, signed agent binaries, the only published port (HTTPS)

Public images: registre-vm.s33d.fr/hypha/server and registre-vm.s33d.fr/hypha/web, for amd64 and arm64.

Useful settings

VariablePurpose
HYPHA_SMTP_HOST, _PORT, _USER, _PASSWORD, _FROM, _SECURITYsending alerts by email
HYPHA_OIDC_ISSUER, _CLIENT_ID, _CLIENT_SECRETOpenID Connect sign-in, in addition to local accounts; only invited accounts get in
HYPHA_VAPID_PRIVATE_KEY, HYPHA_VAPID_SUBJECTpush notifications to phones and computers: key generated by docker compose exec api python -m hypha vapid-key (see Mobile app); empty, the channel is off
HYPHA_LLM_URL, HYPHA_LLM_MODELyour Ollama-style model server, for outage explanations and postmortems; empty, the feature is off
HYPHA_ALLOW_PRIVATE_TARGETSallow synthetic tests and webhooks towards internal addresses
HYPHA_LOG_LEVELserver log level
HYPHA_OTEL_ENDPOINT, HYPHA_OTEL_SAMPLEtraces of the server itself, through an agent's OTLP relay

Accounts

When self-hosting, accounts are local. Add them from Settings › Members, or from the command line:

docker compose exec api python -m hypha create-user --org <slug> --login maria --role member

Update

# in .env: HYPHA_VERSION=<new version>
docker compose pull
docker compose up -d

The migrate service runs migrations before the API restarts. The kit serves the signed agent binaries and their signature: your agents update from your server (see Fleet and updates).

Back up

docker compose exec -T db pg_dump -U hypha -Fc hypha > hypha-$(date +%F).dump

Licences

The server and interface are distributed under the AGPL v3 licence, the agent under the Apache 2.0 licence. The Libre plan has no limit and no billing. Support with guaranteed response times is part of the Entreprise plan of the hosted service.

Updated: 20 November 2026