Documentation

Run it. Peer it. Own it.

Guides that start from what you want to do, the full per-product reference ingested straight from each repo, the HTTP API, and deep dives for self-hosters and contributors.

Start here

New to Vulos? Follow this path in order — understand what it is, install it on a machine you own, then find your way around the desktop.

Using Vulos

Up and running? These are the everyday guides — click-by-click walks through the desktop, the apps, and common tasks, no jargon.

Install Vulos, in depth

7 steps · ~20 min

Install Vulos

Pick a machine — a mini-PC, an old laptop, or a cloud VPS (Hetzner, DigitalOcean, Fly.io) — get the image on it, sign in, then optionally add a domain with TLS and a relay so it's reachable from anywhere. One guide, start to finish.

Read the guide

Reachability

Reach your box from anywhere — reachability is built into the OS. Behind a home router you run a relay yourself: a cheap cloud VPS in relay mode that your box dials out to (so your home network opens no ports). Go direct if you have a public IP, run several relays for redundancy, or add an experimental broker like Pier alongside. Vulos the org operates none of it.

Apps & projects

5 mini-sites

The peripheral open-source projects keep their docs alongside their own landing page — follow the link into each product’s mini-site.

When things break

Self-serve fixes for the problems that actually happen.

For admins & operators

A separate track for running Vulos for other people: installing on cloud servers, running your own relays, deploying, self-hosting the suite, and building on the OS. Not the way in for most people.

Kotva · the protocol family underneath

Vulos federates over Kotva — the substrate spec family (mail, work, commerce) that lets boxes reach and trust each other without a central authority. It has its own home; these docs stay focused on the OS and its management.

Read the whitepaper