# SiYuan Note

SiYuan Note is an open-source, block-based knowledge base for personal knowledge management. It is open source and self-hosted, installable on Docker Hub and ZimaOS.

Canonical page: https://ourlocalhost.com/app/3843/siyuan-note

## Description

SiYuan Note is an open-source, block-based knowledge base for personal knowledge management. It organises your notes into linked blocks with two-way references, attribute filters, and SQL-style queries, so you can search and reshape your knowledge instead of scrolling through folders. The built-in editor supports Markdown, WYSIWYG, list outlines, and block zooming for long documents, while desktop, mobile, and self-hosted server builds keep everything in sync. Most features are free to use, including for commercial projects, making it a self-hostable alternative to closed note services.

## Platform availability

Available on 4 of 10 platforms: ZimaOS, Mac, Linux, Any server.

## Desktop and other devices

Mac, Linux.

## Health score

82/100 (Excellent), based on 4 of 4 factors.
- Maintained: 100 (last commit 23 days ago)
- Popular: 93 (47,127 GitHub stars)
- Easy to install: 65 (4 install platforms, install notes, Docker image)
- Light to run: 40 (4 GB minimum RAM, runs on ARM)

## Links

- Documentation: https://b3log.org/siyuan/en/community.html
- Docker Hub: https://hub.docker.com/r/b3log
- GitHub: https://github.com/siyuan-note/siyuan
- ZimaOS: https://github.com/IceWhaleTech/CasaOS-AppStore/tree/main/Apps/Siyuan-Note
- Official website: https://b3log.org/siyuan
- desktop: https://github.com/siyuan-note/siyuan/releases/latest

## 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.

---
Source: Our Local Host (https://ourlocalhost.com/app/3843/siyuan-note), the self-hosted and open-source app directory.
