SiYuan

stack Documents / Productivity / Wiki

Note-taking app built from blocks, so any paragraph can be linked, embedded or queried from anywhere else. Markdown, backlinks, a graph view and daily notes.

Source code

Install SiYuan

It isn't in the main Portainer Templates list yet, so use this one. Portainer takes one URL at a time, so it swaps out whatever list you had before.

In Portainer, head to Settings --> App Templates, paste this in as the URL and save.

https://raw.githubusercontent.com/NotAFlightRisk/portainer-templates-extras/main/templates.json

Open App Templates and pick SiYuan.
Fill in Access code. Everything else can stay as it is.
Hit Deploy the stack, then open http://<your-server>:6806 in a browser.

The same file Portainer deploys. It reads its settings from a .env next to it.

services:
  siyuan:
    image: b3log/siyuan:latest
    restart: unless-stopped
    command: ["serve"]
    ports:
      - "${SIYUAN_PORT:-6806}:6806"
    environment:
      SIYUAN_ACCESS_AUTH_CODE: ${SIYUAN_ACCESS_AUTH_CODE:?Set an access code}
      TZ: ${SIYUAN_TZ:-UTC}
    volumes:
      - siyuan-workspace:/siyuan/workspace

volumes:
  siyuan-workspace:

Fill in the blanks, as SiYuan won't start without them.

# Access code (required) - What you type in to open your notes, and the only thing between them and anyone who can reach the port. Make it long, or generate one with: openssl rand -hex 16
SIYUAN_ACCESS_AUTH_CODE=

# Host port for the web UI
SIYUAN_PORT=6806

# Timezone - Like Europe/London. Daily notes and timestamps use it.
SIYUAN_TZ=UTC

Grab the file and start it.

mkdir siyuan && cd siyuan
curl -fsSL -o compose.yml https://raw.githubusercontent.com/NotAFlightRisk/portainer-templates-extras/main/apps/siyuan/compose.yml
# save the .env tab here as .env first
docker compose up -d

Before you start

Set the access code before you deploy, since the stack won't start without one. Then open http://<your-host>:6806 (or whichever port you picked) and enter it. It takes half a minute or so to start. Every note, asset and setting lives in the siyuan-workspace volume. To change the code later, just change it here and redeploy. Docs: github.com/siyuan-note/siyuan

Settings

What the Portainer form asks for. With compose they go in the .env file instead.

Variable	What it's for	Default
`SIYUAN_ACCESS_AUTH_CODE`	Access code (required) What you type in to open your notes, and the only thing between them and anyone who can reach the port. Make it long, or generate one with: openssl rand -hex 16	Needs filling in
`SIYUAN_PORT`	Host port for the web UI	`6806`
`SIYUAN_TZ`	Timezone Like Europe/London. Daily notes and timestamps use it.	`UTC`

Services

The containers this stack runs, with ports as they come out of the box.

Service	Image	Ports
`siyuan`	`b3log/siyuan:latest`	`6806:6806`

Install SiYuan

Before you start

Settings

Services

More apps

AFFiNE

Etherpad

Apache Answer

BentoPDF