Coming soon. The Wiki is in active development, so features and these docs may still change. Early adopters: contact us for access.

Install the Wiki

Start the server and the web app, the setup key, the reverse proxy with its WebSocket paths, and request sizes

The Wiki isn't released yet. Early adopters: contact us for access to get the server and a licence.

The Wiki is self-hosted: a server program and a web app, in front of PostgreSQL, optional Redis and file storage. Before you start, plan the installation. There are no container images or Helm chart for the Wiki yet: run the two programs as services on your own hosts or in your own containers.

1. The two programs

ProgramListens onNeeds
Server (wiki-server)PORT (8080) on BIND_ADDR (127.0.0.1)CONFIG_ENCRYPTION_KEY on every start; DATABASE_URL on its first start
Web appPort 3002BACKEND_URL, where the server is (default http://127.0.0.1:8080)

Keep the default BIND_ADDR when the web app and the proxy run on the same host as the server; set 0.0.0.0 (or a private address) when they don't.

2. First boot

Set DATABASE_URL and CONFIG_ENCRYPTION_KEY, then start the server. After the first boot the database URL is saved encrypted on the server, so later boots only need the encryption key.

export CONFIG_ENCRYPTION_KEY="$(cat /run/secrets/wiki-encryption-key)"
export DATABASE_URL='postgres://wiki:…@db.internal:5432/wiki?sslmode=verify-full'
./wiki-server

CONFIG_ENCRYPTION_KEY is required on every start and protects every stored credential. Use a long random value (for example openssl rand -base64 32), the same on every server, and keep it somewhere safe: without it the installation can't start.

3. The setup key

A fresh installation starts in setup mode and prints a one-time setup key in its log, in a line like open the setup wizard … setup_url=https://…/setup?token=…. Open that address: setup only proceeds with the key, so nobody else who can reach the server can take it over first. The page removes the key from the address bar as soon as it has read it. The key changes on every restart; set SETUP_TOKEN to choose it yourself.

The setup wizard then asks for the licence, the database, storage, the optional Redis cache and the first administrator. To set up with nobody at a browser, see Set up without the UI.

4. Behind a proxy

Set TRUSTED_PROXIES on the server to the addresses of your load balancer and any other proxy in front (IPs or CIDRs, comma-separated). Client addresses are used for IP allowlists, rate limits, the audit log and the per-address limits on anonymous readers and calendar feeds: without the right setting, everyone behind the proxy shares one address and one budget.

Set FRONTEND_BEHIND_PROXY=true on the web app when the proxy in front of it sets X-Forwarded-For, X-Forwarded-Host and X-Forwarded-Proto (Caddy does by default, the nginx example below does). The web app then passes them on to the server. Without it they're ignored, because anyone who reaches the web app's port directly could send their own.

With FRONTEND_BEHIND_PROXY=true, only the proxy may reach the web app's port: a client that reaches it directly can choose the address the Wiki sees.

5. Route live editing to the server

Live editing and instant alerts use WebSockets under /api/ws on the same address as the app: each page being edited has its own connection at /api/ws/spaces/<space>/pages/<page>/collab. The web app can't pass these on, so the proxy must send /api/ws and everything under it straight to the server, with WebSocket upgrades allowed, and everything else to the web app:

PathGoes toNotes
/api/ws, /api/ws/…Server (port 8080)Allow the WebSocket upgrade; keep idle connections open for at least an hour
Everything elseWeb app (port 3002)
# Caddy
wiki.example.com {
    @live path /api/ws /api/ws/*
    reverse_proxy @live 127.0.0.1:8080
    reverse_proxy 127.0.0.1:3002
}

# nginx (inside server { … })
client_max_body_size 201m;  # page videos; other API requests stay at 32 MiB
location /api/ws {
    proxy_pass http://127.0.0.1:8080;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_set_header Host $host;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Host $host;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_read_timeout 1h;
}
location / {
    proxy_pass http://127.0.0.1:3002;
    proxy_set_header Host $host;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Host $host;
    proxy_set_header X-Forwarded-Proto $scheme;
}

Without this route, the editor can't connect: after three tries it says so, and people can't edit pages together. Alerts still arrive, every 30 seconds instead of at once, and the system check shows a Live updates warning until it's fixed.

Cloud load balancers (AWS ALB, Azure Application Gateway, Google Cloud Load Balancing) pass WebSockets through: add a path rule for /api/ws* to the server and raise the idle timeout.

6. Request size

The web app refuses API requests larger than FRONTEND_API_BODY_LIMIT bytes (32 MiB by default) with 413 payload_too_large before they reach the server. Uploads to a page (images and videos) have their own limit of 201 MiB, enough for a 200 MiB video, whatever that variable says. The server applies the same limits itself, also to requests that reach it directly or arrive in chunks (413 payload_too_large). Let the proxy in front take bodies that large (nginx: client_max_body_size 201m).

7. Logs and secrets in addresses

Calendar apps read a person's calendar feed with its secret in the address, because they can't send headers. The Wiki's server never logs request queries, but a proxy in front may: leave queries out of your proxy's access log for /api/calendar/ical, or keep that log as private as the feeds.

8. After an update

When the Wiki is updated, pages people already have open notice within a few minutes, or as soon as they return to the tab, and show A new version is available with Reload and Later. Nothing reloads on its own. Proxies and CDNs must not cache the /app-version address.

9. Security headers

Pages are served with security headers (frames from other sites are refused, the referrer is trimmed, HSTS) and an enforced Content-Security-Policy; violations are logged by the web app as [csp] lines (CSP_ENFORCE=false sends it report-only). Pages may frame videos only from the sites allowed in Settings → Security → Video sites. HTML blocks run in a sandboxed frame with a policy of their own: they can reach only the sites in Settings → Security → HTML blocks, and never the Wiki itself.

The Wiki needs its own host name: it can't be served under a path such as https://tools.example.com/wiki/.

Once signed in, everyone has a ? (Help) menu at the top of every page and a footer at the bottom with the version, build and the server that answered. Out of the box, Documentation, Getting started and What's new open these docs, and Report a bug and Contact support reach Vectored. Point them at your own help desk under Settings → General → Help menu (settings:write), or leave a link empty to hide it.