siyuan-note/siyuan
siyuan-note/siyuanOn GitHub, siyuan-note/siyuan has picked up 45.6k stars, Developer Tools, TypeScript. A privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Snapshot
Top contributors
Show top contributors
Refactor your thinking
English | 中文 | 日本語 | Türkçe
Table of Contents
- 💡 Introduction
- 🔮 Features
- 🏗️ Architecture and Ecosystem
- 🗺️ Roadmap
- 🚀 Download Setup
- App Market
- Installation Package
- Package Manager
- Docker Hosting
- Unraid Hosting
- TrueNAS Hosting
- Insider Preview
- ⌨️ Command-line Interface
- 🏘️ Community
- 🛠️ Development Guide
- ❓ FAQ
- How does SiYuan store data?
- Does it support data synchronization through a third-party sync disk?
- Is SiYuan open source?
- How to upgrade to a new version?
- What if some blocks (such as paragraph blocks in list items) cannot find the block icon?
- What should I do if the data repo key is lost?
- Do I need to pay for it?
- 🙏 Acknowledgement
- Contributors
💡 Introduction
SiYuan is a privacy-first personal knowledge management system, supporting fine-grained block-level reference and Markdown WYSIWYG.
Welcome to SiYuan English Discussion Forum to learn more.
Online user guide: English
🔮 Features
Most features are free, even for commercial use.
- Content block
- Block-level reference and two-way links
- Custom attributes
- SQL query embed
- Protocol
siyuan://
- Editor
- Block-style
- Markdown WYSIWYG
- List outline
- Block zoom-in
- Million-word large document editing
- Mathematical formulas, charts, flowcharts, Gantt charts, timing charts, staves, etc.
- Web clipping
- PDF Annotation link
- Export
- Block ref and embed
- Standard Markdown with assets
- PDF, Word and HTML
- Copy to WeChat MP, Zhihu and Yuque
- Database
- Table view
- Flashcard spaced repetition
- AI writing and Q/A chat via OpenAI API
- Tesseract OCR
- Multi-tab, drag and drop to split screen
- Template snippet
- JavaScript/CSS snippet
- Android/iOS/HarmonyOS App
- Docker deployment
- API
- Community marketplace
Some features are only available to paid members, for more details please refer to Pricing.
🏗️ Architecture and Ecosystem
| Project | Description | Forks | Stars |
|---|---|---|---|
| lute | Editor engine |  |  |
| chrome | Chrome/Edge extension |  |  |
| bazaar | Community marketplace |  |  |
| dejavu | Data repo |  |  |
| petal | Plugin API |  |  |
| android | Android App |  |  |
| ios | iOS App |  |  |
| harmony | HarmonyOS App |  |  |
| riff | Spaced repetition |  |  |
🗺️ Roadmap
- SiYuan development plan and progress
- SiYuan changelog
🚀 Download Setup
It is recommended to give priority to installing through the application market on desktop and mobile, so that you can upgrade the version with one click in the future.
App Market
Mobile:
- App Store
- Google Play
- F-Droid
Desktop:
- Microsoft Store
Installation Package
- B3log
- GitHub
Package Manager
siyuan
siyuan-note
Docker Hosting
Docker Deployment
Overview
The easiest way to serve SiYuan on a server is to deploy it through Docker.
- Image name
b3log/siyuan - Image URL
File structure
The overall program is located under /opt/siyuan/, which is basically the structure under the resources folder of the Electron installation package:
- appearance: icon, theme, languages
- guide: user guide document
- stage: interface and static resources
- kernel: kernel program
Entrypoint
The entry point is set when building the Docker image: ENTRYPOINT ["/opt/siyuan/entrypoint.sh"]. This script allows changing the PUID and PGID of the user that will run inside the container. This is especially relevant to solve permission issues when mounting directories from the host. The PUID (User ID) and PGID (Group ID) can be passed as environment variables, making it easier to ensure correct permissions when accessing host-mounted directories.
Use the following parameters when running the container with docker run b3log/siyuan:
Note: Since v3.7.0, the
servesubcommand must be passed explicitly (e.g.docker run b3log/siyuan serve --workspace=...). Rundocker run --rm b3log/siyuan serve --helpto see all serving options.
--workspace: Specifies the workspace folder path, mounted to the container via-von the host--accessAuthCode: Specifies the lock screen password
More parameters can be found using --help. Here’s an example of a startup command with the new environment variables:
docker run -d \
-v workspace_dir_host:workspace_dir_container \
-p 6806:6806 \
-e PUID=1001 -e PGID=1002 \
b3log/siyuan \
serve \
--workspace=workspace_dir_container \
--accessAuthCode=xxx
PUID: Custom user ID (optional, defaults to1000if not provided)PGID: Custom group ID (optional, defaults to1000if not provided)workspace_dir_host: The workspace folder path on the hostworkspace_dir_container: The path of the workspace folder in the container, as specified in--workspace- Alternatively, it's possible to set the path via the
SIYUAN_WORKSPACE_PATHenv variable. The commandline will always have the priority, if both are set
- Alternatively, it's possible to set the path via the
accessAuthCode: Lock screen password (please be sure to modify, otherwise anyone can access your data)- Alternatively, it's possible to set the lock screen password via the
SIYUAN_ACCESS_AUTH_CODEenv variable. The commandline will always have the priority, if both are set - To disable the lock screen password set the env variable
SIYUAN_ACCESS_AUTH_CODE_BYPASS=true
- Alternatively, it's possible to set the lock screen password via the
SIYUAN_LANG: Interface language (optional, defaults toenif unset in Docker). Accepts BCP 47 tags likezh-CN/zh-TW/en/ja/pt-BR; legacy underscore values likezh_CN/en_USare also accepted for backward compatibility. Omit it if you want the language chosen in Settings to persist across restarts; if set, it is applied on every startup and overrides the saved setting- Alternatively, use the
--langcommand-line parameter. If both are set, the command-line takes priority
- Alternatively, use the
To simplify things, it is recommended to configure the workspace folder path to be consistent on the host and container, such as having both workspace_dir_host and workspace_dir_container configured as /siyuan/workspace. The corresponding startup command would be:
docker run -d \
-v /siyuan/workspace:/siyuan/workspace \
-p 6806:6806 \
-e PUID=1001 -e PGID=1002 \
b3log/siyuan \
serve \
--workspace=/siyuan/workspace/ \
--accessAuthCode=xxx
Docker Compose
For users running SiYuan with Docker Compose, the environment variables PUID and PGID can be passed to customize the user and group IDs. Here's an example of a Docker Compose configuration:
version: "3.9"
services:
main:
image: b3log/siyuan
command: ['serve', '--workspace=/siyuan/workspace/', '--accessAuthCode=${AuthCode}']
ports:
- 6806:6806
volumes:
- /siyuan/workspace:/siyuan/workspace
restart: unless-stopped
environment:
- TZ=${YOUR_TIME_ZONE} # A list of time zone identifiers can be found at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
- PUID=${YOUR_USER_PUID} # Customize user ID
- PGID=${YOUR_USER_PGID} # Customize group ID
In this setup:
PUIDandPGIDare set dynamically and passed to the container- If these variables are not provided, the default
1000will be used
By specifying PUID and PGID in the environment, you avoid the need to explicitly set the user directive (user: '1000:1000') in the compose file. The container will dynamically adjust the user and group based on these environment variables at startup.
User Permissions
In the image, the entrypoint.sh script ensures the creation of the siyuan user and group with the specified PUID and PGID. Therefore, when the host creates a workspace folder, pay attention to setting the user and group ownership of the folder to match the PUID and PGID you plan to use. For example:
chown -R 1001:1002 /siyuan/workspace
If you use custom PUID and PGID values, the entrypoint script will ensure that the correct user and group are created inside the container, and ownership of mounted volumes will be adjusted accordingly. There’s no need to manually pass -u in docker run or docker-compose as the environment variables will handle the customization.
Hidden port
Use an NGINX reverse proxy to hide port 6806. Please note:
- Configure the WebSocket reverse proxy for
/ws
Note
- Be sure to confirm the correctness of the mounted volume, otherwise the data will be lost after the container is deleted
- Do not use URL rewriting for redirection, otherwise there may be problems with authentication, it is recommended to configure a reverse proxy
- If you encounter permission issues, verify that the
PUIDandPGIDenvironment variables match the ownership of the mounted directories on your host system
Limitations
- Does not support desktop and mobile application connections, only supports use on browsers
- Export to PDF, HTML and Word formats is not supported
- Import Markdown file is not supported
Unraid Hosting
Unraid Deployment
Note: First run chown -R 1000:1000 /mnt/user/appdata/siyuan in the terminal
Template reference:
Web UI: 6806
Container Port: 6806
Container Path: /home/siyuan
Host path: /mnt/user/appdata/siyuan
PUID: 1000
PGID: 1000
Publish parameters: serve --accessAuthCode=******(Lock screen password)
TrueNAS Hosting
TrueNAS Deployment
Note: First, run the commands below in the TrueNAS Shell. Please update Pool_1/Apps_Data/siyuan to match your dataset path.
zfs create Pool_1/Apps_Data/siyuan
chown -R 1001:1002 /mnt/Pool_1/Apps_Data/siyuan
chmod 755 /mnt/Pool_1/Apps_Data/siyuan
Navigate to Apps - DiscoverApps - More Options (on top right, besides Custom App) - Install via YAML
Template reference:
services:
siyuan:
image: b3log/siyuan
container_name: siyuan
command: ['serve', '--workspace=/siyuan/workspace/', '--accessAuthCode=2222']
ports:
- 6806:6806
volumes:
- /mnt/Pool_1/Apps_Data/siyuan:/siyuan/workspace # Adjust to your dataset path
restart: unless-stopped
environment:
- TZ=America/New_York # Replace with your timezone if needed
- PUID=1001
- PGID=1002
Insider Preview
We release insider preview before major updates, please visit https://github.com/siyuan-note/insider.
⌨️ Command-line Interface
The built-in CLI provides direct access to workspace data — no running server required.
Quick Start
# List all notebooks
siyuan notebook list -w ~/SiYuan
# Full-text search with JSON output
siyuan search "keyword" -w ~/SiYuan -f json
# Search inside asset files (PDF/Word/Excel/txt etc.)
siyuan search "phrase" --asset -w ~/SiYuan
siyuan search "phrase" --asset --ext pdf --ext docx -w ~/SiYuan
# Export a document as Markdown
siyuan export md --id <block-id> -w ~/SiYuan
Available Commands
| Category | Commands |
|---|---|
| Notebooks & Documents | notebook, document, dailynote — CRUD and daily notes |
| Content | block, attr, outline — block read/write, attributes, outline |
| Metadata | tag, bookmark, template — tags, bookmarks, template snippets |
| Queries | search, sql — full-text, semantic, asset-content, and SQL queries |
| References | ref — backlinks and mentions |
| Import/Export | export, import, inbox — Markdown, HTML, preview, Word, .sy.zip, Data, cloud inbox |
| Data Management | repo, history, sync — snapshots, versions, cloud sync |
| Utilities | asset, file — resources and file system |
| Database | database — attribute view management |
| Server | serve — start the kernel HTTP server |
| Workspace & System | workspace, system — list, inspect, system info |
Run siyuan --help for the full command tree. Use -f json (default is -f table) for script-friendly output. Most mutating commands also support --dry-run to preview changes without applying them.
Installation
The CLI binary is <install-dir>/resources/kernel/SiYuan-Kernel, invoked via the siyuan command.
- Windows: the installer automatically adds the kernel directory to
PATH, sosiyuanworks out of the box. The Microsoft Store edition runs in an MSIX sandbox and cannot modifyPATH; deploy asiyuan.cmdshim once (survives Store updates):
To remove on uninstall:# Microsoft Store edition only — run once in PowerShell $shimDir = "$env:LOCALAPPDATA\Microsoft\WindowsApps" # already in PATH by default @( '@echo off' 'setlocal' 'set "ROOT="' 'for /f "delims=" %%i in (''powershell -NoProfile -Command "(Get-AppxPackage *SiYuan*).InstallLocation"'') do set "ROOT=%%i"' 'if not defined ROOT goto :noshim' '"%ROOT%\app\resources\kernel\SiYuan-Kernel.exe" %*' 'exit /b %ERRORLEVEL%' ':noshim' '1>&2 echo siyuan: Microsoft Store edition not found' 'exit /b 1' ) | Set-Content "$shimDir\siyuan.cmd"Remove-Item "$env:LOCALAPPDATA\Microsoft\WindowsApps\siyuan.cmd". - macOS: create a symlink after installing:
ln -s /Applications/SiYuan.app/Contents/Resources/kernel/SiYuan-Kernel /usr/local/bin/siyuan - Linux: create a symlink after installing:
ln -s <install-dir>/resources/kernel/SiYuan-Kernel /usr/local/bin/siyuan
🏘️ Community
- English Discussion Forum
- User community summary
- Awesome SiYuan
🛠️ Development Guide
See Development Guide.
❓ FAQ
How does SiYuan store data?
The data is saved in the workspace data folder:
assetsis used to save all inserted assetsemojisis used to save emoji imagessnippetsis used to save code snippetsstorageis used to save query conditions, layouts and flashcards, etc.templatesis used to save template snippetswidgetsis used to save widgetspluginsis used to save pluginspublicis used to save public data- The rest of the folders are the notebook folders created by the user, files with the suffix of
.syin the notebook folder are used to save the document data, and the data format is JSON
Does it support data synchronization through a third-party sync disk?
Data synchronization through third-party synchronization disks is not supported, otherwise data may be corrupted.
Although it does not support third-party sync disks, it supports connecting with third-party cloud storage (Members' privileges).
Is SiYuan open source?
SiYuan is completely open source, and contributions are welcome:
- User Interface and Kernel
- Android
- iOS
- HarmonyOS
- Chrome Clipping Extension
For more details, please refer to Development Guide.
How to upgrade to a new version?
- If installed via app store, please update via app store
- If it is installed with the desktop installation package on Windows or macOS, you can enable the option of Settings - About - Automatically download update installation package, so that SiYuan will automatically download the latest version of the installation package and prompt to install
- If it is installed by manual installation package, please download the installation package again to install
You can Check update in Settings - About - Current Version, or pay attention to Official Download or GitHub Releases to get the new version.
What if some blocks (such as paragraph blocks in list items) cannot find the block icon?
The block icon is omitted for the first sub-block under the list item. You can move the cursor into this block and trigger its block menu with Ctrl+/ .
What should I do if the data repo key is lost?
-
If the data repo key is correctly initialized on multiple devices previously, the key is the same on all devices and can be retrieved in Settings - Account & Sync - Local Data Repo - Data repo key - Copy key string
-
If it has not been configured correctly before (for example, the keys on multiple devices are inconsistent) or all devices are unavailable and the key string cannot be obtained, you can reset the key by following the steps below:
- Manually back up the data, you can use Export Data or directly copy the workspace/data/ folder on the file system
- Settings - Account & Sync - Local Data Repo - Data repo key - Reset data repo
- Reinitialize the data repo key. After initializing the key on one device, other devices import the key
- The cloud uses the new synchronization directory, the old synchronization directory is no longer available and can be deleted
- The existing cloud snapshots are no longer available and can be deleted
Do I need to pay for it?
Most features are free, even for commercial use.
Member's privileges can only be used after payment, please refer to Pricing.
🙏 Acknowledgement
The birth of SiYuan is inseparable from many open source projects and contributors. Please refer to the project source code kernel/go.mod, app/package.json and project homepage.
The growth of SiYuan is inseparable from user feedback and promotion. Thank you, everyone, for your help with SiYuan ❤️
Contributors
Welcome to join us and contribute code to SiYuan together.
Related repositories
Turn any codebase, with its docs, SQL schemas, configs, and PDFs, into a queryable knowledge graph. A /graphify skill for Claude Code, Cursor, Codex, and Gemini CLI: local deterministic AST parsing, every edge explained, no vector store.
#1 PDF Application on GitHub that lets you edit PDFs on any device anywhere
Graphs that teach > graphs that impress. Turn any code into an interactive knowledge graph you can explore, search, and ask questions about. Works with Claude Code, Codex, Cursor, Copilot, Gemini CLI, and more.
Graphs that teach > graphs that impress. Turn any code into an interactive knowledge graph you can explore, search, and ask questions about. Works with Claude Code, Codex, Cursor, Copilot, Gemini CLI, and more.
Quick answers
How active is development on siyuan-note/siyuan?
The most recent commit recorded on siyuan-note/siyuan was 6 days ago, based on the GitHub push timestamp. The repository has 2.9k forks — one of the better signals of community interest.
How does siyuan-note/siyuan compare to other Developer Tools projects?
siyuan-note/siyuan is tracked by TopGit in the Developer Tools category, with 45.6k GitHub stars and written in TypeScript. Browse the Developer Tools topic page on TopGit to compare it against similar projects by stars and activity.
How many stars does siyuan-note/siyuan have?
siyuan-note/siyuan has 45.6k GitHub stars — refresh the page for the live number, or check github.com/siyuan-note/siyuan. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is siyuan-note/siyuan open source?
Yes — siyuan-note/siyuan ships under the AGPL-3.0 license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/siyuan-note/siyuan.
What is siyuan-note/siyuan?
siyuan-note/siyuan (siyuan-note/siyuan) is a TypeScript project on GitHub. From the project's own README: A privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang.
Where do I read more about siyuan-note/siyuan?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/siyuan-note/siyuan is the definitive source.
Read full README in the tab above.