Self-host AFFiNE on a VPS

A block-based workspace combining docs, whiteboards, and databases in one self-hosted app.

levelrail-cli templates deploy affine --name my-affine

Specification

Status
Listed
Category
Productivity
Services
affine, db, redis
Ports
3010
Volumes
4
Memory
about 1 GiB
arm64
image published
amd64
image published
Settings to fill in
none
License
not yet recorded

About AFFiNE

A block-based workspace combining docs, whiteboards, and databases in one self-hosted app. Runs 3 containers (affine, db, redis), with affine listening on port 3010; data is kept in named volumes.

What it deploys

AFFiNE runs as 3 services in a single Compose app, listening on port 3010, with 4 named volume mounts.

ServiceImageTagPortsVolumes
affine ghcr.io/toeverything/affine stable 3010 affine_storage -> /root/.affine/storageaffine_config -> /root/.affine/config
db pgvector/pgvector pg16 none affine_db_data -> /var/lib/postgresql/data
redis redis 7-alpine none affine_redis_data -> /data

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Listed. It is in the catalog. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 3010 directly on the host, so open them in the VPS firewall only if you want that.

Settings and environment

You do not have to fill in anything. 2 secrets are generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
affineAFFINE_SERVER_HOSTPreset by the template
affineAFFINE_SERVER_HTTPSPreset by the template
affineAFFINE_SERVER_PORTPreset by the template
affineDATABASE_URLGenerated at deploy
affineNODE_ENVPreset by the template
affineREDIS_SERVER_HOSTPreset by the template
dbPOSTGRES_DBPreset by the template
dbPOSTGRES_PASSWORDGenerated at deploy
dbPOSTGRES_USERPreset by the template

Install AFFiNE on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get affine
  4. Deploy it

    This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.

    levelrail-cli templates deploy affine --name my-affine

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then AFFiNE.

More in Productivity

All Productivity templates