Self-host SiYuan on a VPS

A privacy-first, self-hosted personal knowledge management app with block-based markdown notes.

levelrail-cli templates deploy siyuan --name my-siyuan

Specification

Status
Listed
Category
Productivity
Services
siyuan
Ports
6806
Volumes
1
Memory
about 512 MiB
arm64
image published
amd64
image published
Settings to fill in
none

About SiYuan

A privacy-first, self-hosted personal knowledge management app with block-based markdown notes. Runs as a single container from the siyuan image, listening on port 6806; data is kept in named volumes.

What it deploys

SiYuan runs as one service in a single Compose app, listening on port 6806, with 1 named volume mount.

ServiceImageTagPortsVolumes
siyuan b3log/siyuan v3.8.6 6806 siyuan_workspace -> /siyuan/workspace

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 6806 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. 1 secret is generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
siyuanPGIDPreset by the template
siyuanPUIDPreset by the template
siyuanSIYUAN_ACCESS_AUTH_CODEGenerated at deploy
siyuanTZPreset by the template

Install SiYuan 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 siyuan
  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 siyuan --name my-siyuan

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

More in Productivity

All Productivity templates