SiYuan Note
SiYuan Note is an open-source, block-based knowledge base for personal knowledge management.
Platform availability
Available on 4 of 10 platforms
- Unraid (not listed)
- TrueNAS (not listed)
- Umbrel (not listed)
- ZimaOS
- Proxmox (not listed)
- Helm (not listed)
- Mac
- Windows (not listed)
- Linux
- Any server
Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.
82/100 Excellent
- Maintained
- 100last commit 23 days ago
- Popular
- 9347,127 GitHub stars
- Easy to install
- 654 install platforms, install notes, Docker image
- Light to run
- 404 GB minimum RAM, runs on ARM
Availability: platform listings confirmed today
- GitHub stars
- 47,127
- Open issues
- 15
- Last commit
- 2026-10-29
- Latest release
- v3.8.9
- License
- AGPL-3.0
- Activity
- declining
Checked 13 days ago - source: GitHub (siyuan-note/siyuan)
Resources & Compatibility
Minimum requirements: 4 GB RAM. ARM (e.g. Raspberry Pi) is supported.
Checked 54 days ago - source: Docker Hub image tags and published docs
First-install notes
- Set folder, login code, and port first Before starting, point the container to a real host folder for SiYuan, set a --accessAuthCode (the web login code), and open port 6806. Without these, SiYuan may not save notes or you may not be able to open it in a browser. source
- Match folder ownership to PUID/PGID Set PUID/PGID (the user and group IDs the container runs as) and make the workspace folder owned by that user, such as chown -R 1001:1002. If ownership is wrong, SiYuan can start but fail to write notes or configuration. source
- Back up the workspace folder Your notes, settings, and uploads live in the mapped workspace folder, so keep that folder safe and back it up. Losing or moving that folder can make it look like all of SiYuan's data disappeared. source
Fetched 53 days ago - each note links to its source
Variants
Alternatives
No alternatives collected yet.
Common questions
Where does SiYuan keep its notes on the hard drive?
You can open a document's location from the Doc Tree. That shows the local data path where the file is stored.
What must I set before starting the SiYuan Docker container?
Point the container to a real host folder, set --accessAuthCode for the web login code, and open port 6806. Without these, SiYuan may not save notes or may not be reachable in a browser.
How should I back up self-hosted SiYuan data?
Back up the mapped workspace folder, because notes, settings, and uploads live there. Losing or moving that folder can make it look like all of SiYuan's data disappeared.
Why can SiYuan start in Docker but fail to save notes?
Match the workspace folder ownership to the container's PUID/PGID, such as with chown -R 1001:1002. If ownership is wrong, SiYuan can start but fail to write notes or configuration.
What reverse-proxy or authentication problem can affect a self-hosted SiYuan instance?
Misconfigured reverse proxies or auth can lead to availability or security issues.
Answers sourced from github.com, refft.com, www.reddit.com
Community
- Any opinions on SiYuan (an apparently very good Notion ... - Reddit (reddit)
- Selfhosted Siyaun Users? : r/siyuan - Reddit (reddit)
- siyuan - Reddit (reddit)
- SiyuanPKM - Reddit (reddit)
- Where does SiYuan keep the notes on the HDd : r/SiyuanPKM - Reddit (reddit)
- SiYuan - Block Based Knowledge Management w/Backlinks - Reddit (reddit)
Collected 48 days ago - public community threads