OpenSource-Hub
S

siyuan

SHA-256
43.8k stars·Office Productivity·SHA-256 checksum verified

A privacy-first personal knowledge management system with fine-grained block-level references and Markdown WYSIWYG.

Smart Download

Download Download Version

v3.6.5 · 188.1 MB

Privacy-first knowledge management with block-level references and Markdown WYSIWYG.

Core Features

  • Block-level references and bidirectional links down to paragraph level
  • WYSIWYG Markdown editor with support for million-word documents
  • Local-first, fully offline, and self-hostable via Docker
  • Built-in database views, flashcards, AI writing, OCR
  • Rich community marketplace for plugins and themes

What It Can't Do

  • Free cloud sync only available via self-hosted server. Third-party sync (iCloud, OneDrive) may corrupt data – use official sync. Advanced features (cloud sync, AI credits) require paid subscription. As AGPLv3 licensed, commercial use must comply with the license.

Use Cases

  • Personal knowledge management and second brain
  • Academic research and note-taking
  • Team collaboration (self-hosted)
  • Long-term diary and project planning

Detailed Introduction

SiYuan is an open-source, privacy-first personal knowledge management system that allows you to create, organize, and connect your knowledge with fine-grained block-level references, bidirectional links, and a WYSIWYG Markdown editor. It supports offline use, self-hosting via Docker, and offers features like to-do lists, flashcards, AI writing, and database views. While most features are free (including commercial use), some advanced capabilities (e.g., cloud sync) require a paid subscription.

Troubleshooting & FAQ (2)

Troubleshooting
Why does my self-hosted deployment keep showing an error prompt and how to fix it?

This error typically indicates missing WebSocket reverse proxy configuration. In your reverse proxy (Nginx, Caddy, etc.), add a WebSocket upgrade rule. For example, in Nginx: location /ws { proxy_pass http://backend; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; }. Refer to the project's README or deployment guide for exact paths and settings. After configuring, restart the proxy.

GitHub Issue #17004
Troubleshooting
How to fix multiple security vulnerabilities in Siyuan Note?

All listed vulnerabilities (GHSA-x6wf-w2rg-2gw9, GHSA-2h64-c999-c9r6, etc.) have been patched in recent updates. Update to the latest version of Siyuan Note: download the newest release from the official GitHub page, or for Docker users run docker pull b3log/siyuan:latest and restart the container. No additional steps are required.

GitHub Issue #17624

Tags

knowledge-managementnote-takingmarkdownprivacyself-hostedopensourceblock-reference

Getting Started

1

Download installer

Click the button above to download the installer for your system

2

Install the software

Install the appropriate package for your distro (dpkg / rpm / AppImage)

3

Download the installer for your OS (Windows/Mac/Linux) or use Docker image

4

Run the installer and follow the setup wizard

5

Launch SiYuan, create a notebook, and start taking notes

Install Guide
  1. Download the installer for your OS (Windows/Mac/Linux) or use Docker image
  2. Run the installer and follow the setup wizard
  3. Launch SiYuan, create a notebook, and start taking notes
File Integrity

SHA-256 checksum verified

Checksum extracted from GitHub official Release page

SHA256 Checksum

4980bd7a8677fe55054886b0d3abb65c24d4d3a6c63ad9be7ea16836930643fa

This checksum is extracted from the GitHub Release page. Verify file integrity after download.

All SHA-256 checksums on this platform are extracted from the project's official GitHub Release page, without any modification. You can independently verify them on the GitHub Releases page.

Open Source Transparency

View GitHub Source
Environment Guide

Uninstall Info

Windows: uninstall via Control Panel; macOS: drag app to Trash; Linux: remove via package manager; Docker: stop and delete container.

No Extra Dependencies

Ready to use after download. No additional runtime required.

Project Info
LicenseAGPL-3.0
Last Updated2026-06-26 21:45:30
GitHub RepositoryOfficial Website

Having issues? Check the FAQ below

2 FAQs

Similar Projects