Self-host SiYuan with Levelrail

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

  • Authorsiyuan-note
  • LicenceAGPL-3.0
  • Memory512 MiB
  • Archarm64
  • Services1

How to self-host SiYuan

  1. Pull the images

    One image is pulled on your server.

    Show images
    • b3log/siyuan:v3.8.6
  2. Create the app

    One service starts in a single Compose app, with 1 named volume mount for your data, on port 6806.

  3. Fill in the secrets

    1 secret is generated and stored encrypted, 3 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

SiYuan requirements

Memory
About 512 MiB
Architectures
amd64 image published, arm64 image published
Ports
6806
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
AGPL-3.0, network copyleft (agpl) license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 6806 on the host, so open them in the VPS firewall only if you want that.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then SiYuan. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the SiYuan docs page.

Deploy SiYuan your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy SiYuan from the CLI

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

Deploy SiYuan with the API

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/siyuan/deploy

SiYuan configuration

SiYuan services

ServiceImagePortsVolumes
siyuan b3log/siyuan:v3.8.6 6806 siyuan_workspace -> /siyuan/workspace

SiYuan environment variables

VariableServiceValue
PGID siyuan Preset by the template
PUID siyuan Preset by the template
SIYUAN_ACCESS_AUTH_CODE siyuan Generated at deploy
TZ siyuan Preset by the template

Ports and volumes

Ports
6806
Volumes
1 named mount: siyuan_workspace -> /siyuan/workspace

SiYuan FAQ

How much memory does SiYuan need?

The catalog lists about 512 MiB of memory for SiYuan.

Does SiYuan run on arm64?

For SiYuan, an arm64 image is published; amd64 is image published.

What licence is SiYuan under?

SiYuan is licensed under AGPL-3.0, which is network copyleft, so source sharing also applies when it is offered as a hosted service.

Does SiYuan need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which ports does SiYuan use?

SiYuan listens on port 6806 inside the stack.

Where does SiYuan keep its data?

In a named volume: siyuan_workspace mounted at /siyuan/workspace.

Can I deploy SiYuan on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for SiYuan, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image b3log/siyuan:v3.8.6 is what you deploy there.

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