SiYuan: Privacy-First, Self-Hosted Personal Knowledge Management Software

Use at your own risk

OSRepos shares public repositories for knowledge and discovery only. Any installation, execution, configuration, or use of code from these repositories is the user's own responsibility. Always review the repository, source code, dependencies, licenses, and security implications before running or installing anything. OSRepos is not responsible for issues, damages, or losses resulting from third-party repositories.

Introduction

SiYuan is a robust, privacy-first, and fully open-source personal knowledge management software. Developed with TypeScript and Go, it empowers users to manage their notes and knowledge base with fine-grained block-level referencing and a Markdown WYSIWYG editor. Designed for self-hosting, SiYuan offers a powerful and transparent alternative for individuals seeking full control over their data.

Installation

SiYuan provides multiple flexible installation options to suit various preferences, from desktop applications to self-hosted server deployments.

Desktop and Mobile Applications

For a quick start, you can download SiYuan directly from official app stores or as an installation package:

App Stores:
Installation Packages:
- B3log Official Downloads
- GitHub Releases

Docker Hosting

For self-hosting enthusiasts, SiYuan can be easily deployed using Docker. This method allows you to run SiYuan on your server and access it via a web browser.

Here's a basic example of how to run SiYuan with Docker:

docker run -d \
  -v /siyuan/workspace:/siyuan/workspace \
  -p 6806:6806 \
  -e PUID=1001 -e PGID=1002 \
  b3log/siyuan \
  --workspace=/siyuan/workspace/ \
  --accessAuthCode=YOUR_SECURE_AUTH_CODE

Remember to replace /siyuan/workspace with your desired host path and YOUR_SECURE_AUTH_CODE with a strong authorization code. For more detailed instructions and Docker Compose configurations, refer to the official Docker documentation in the README.

Examples

SiYuan is packed with features designed to enhance your knowledge management workflow:

Block-level Referencing and Two-way Links: Create intricate connections between your notes, fostering a rich web of knowledge.
Markdown WYSIWYG Editor: Enjoy a seamless writing experience with real-time Markdown rendering.
AI Integration: Leverage AI writing and Q&A chat capabilities via OpenAI API for enhanced content creation and information retrieval.
Flashcard Spaced Repetition: Integrate learning and memory retention directly into your notes.
PDF Annotation Link: Annotate PDFs and link directly to specific sections within your SiYuan notes.
Multi-tab and Split Screen: Organize your workspace efficiently with multiple tabs and drag-and-drop split-screen functionality.
Cross-platform Availability: Access your knowledge base on Android, iOS, HarmonyOS, and desktop platforms.
Extensible Ecosystem: Benefit from a community marketplace for plugins and a comprehensive API for custom integrations.

Why Use SiYuan

Choosing SiYuan means opting for a powerful, flexible, and user-centric knowledge management solution. Its commitment to privacy ensures your data remains yours, while its self-hosted nature gives you complete control over your information. The rich feature set, including advanced linking, AI tools, and spaced repetition, caters to diverse needs, from personal note-taking to academic research. As a fully open-source project, SiYuan benefits from community contributions, offering transparency and continuous improvement. It stands as a compelling alternative to proprietary solutions like Notion or Obsidian, particularly for those prioritizing data ownership and extensibility.