DEV.co
MCP Servers · siyuan-note

siyuan

SiYuan is a self-hosted, open-source personal knowledge management system written in TypeScript and Go. It emphasizes privacy, local-first data storage, and block-level linking with Markdown WYSIWYG editing.

Source: GitHub — github.com/siyuan-note/siyuan
45k
GitHub stars
2.9k
Forks
TypeScript
Primary language
AGPL-3.0
License (OSI-approved)

Key facts

Objective fields from the source. Values we can't verify are shown as “Unknown” rather than guessed.

FieldValue
Repositorysiyuan-note/siyuan
Ownersiyuan-note
Primary languageTypeScript
LicenseAGPL-3.0 — OSI-approved
Stars45k
Forks2.9k
Open issues318
Latest releasev3.7.1 (2026-07-04)
Last updated2026-07-08
Sourcehttps://github.com/siyuan-note/siyuan

What siyuan is

Built on TypeScript (frontend) and Go (backend) with Electron desktop deployment and Docker containerization support. Features block-level bidirectional references, SQL query embeds, API access, and plugin architecture via Petal. Data stored locally with optional WebDAV/S3 sync.

Quickstart

Get the siyuan source

Clone the repository and explore it locally.

terminalbash
git clone https://github.com/siyuan-note/siyuan.gitcd siyuan# follow the project's README for install & configuration

Need it deployed, integrated, or customized instead? DEV.co ships production installs.

Best use cases

Private Knowledge Base for Organizations

Self-hosted PKM for teams requiring full data ownership and no cloud dependency. AGPL-3.0 allows internal use; deploy on premises or private infrastructure.

Research & Academic Note-Taking

Block-level referencing, bidirectional links, and citation-friendly exports (Markdown, PDF, Word) support complex research workflows. Local storage ensures offline access.

Personal Wiki & Digital Garden

Markdown WYSIWYG, template snippets, and flashcard spaced repetition enable individual knowledge capture, curation, and learning reinforcement.

Implementation considerations

  • Plan infrastructure for local data storage; evaluate WebDAV/S3 sync feasibility and backup strategy before migration.
  • AGPL-3.0 license requires legal review if software modifications will be distributed or served over network; internal-only use is safer.
  • Evaluate plugin ecosystem (Petal) and community marketplace maturity for required extensions; custom JavaScript/CSS snippets may be necessary.
  • Assess OpenAI API dependency for AI features; ensure API costs and privacy policy align with organizational requirements.
  • Test migration from competing PKM tools; API documentation exists but data import workflows not detailed in provided data.

When to avoid it — and what to weigh

  • Strict proprietary software requirement — AGPL-3.0 copyleft obligation requires source disclosure for network-distributed modifications. Closed-source deployments not feasible without proprietary licensing.
  • Zero self-hosting tolerance — No official SaaS offering. Requires active infrastructure management, Docker/Kubernetes operational overhead, and backup responsibility.
  • Enterprise real-time collaboration at scale — No multi-user concurrency locking documented. Designed for single/small-team offline-first workflows. WebDAV sync is eventual-consistency, not true CRDT.
  • Minimal dependency footprint — Electron desktop client incurs significant bundle size and memory overhead; Docker image similarly large. Not suitable for embedded/resource-constrained environments.

License & commercial use

Licensed under AGPL-3.0 (GNU Affero General Public License v3.0). Copyleft license requiring source disclosure if software is modified and network-distributed. Internal/proprietary use requires careful legal assessment.

AGPL-3.0 permits commercial use for internal operations without distribution. External SaaS offerings, commercial forks, or network-distributed modifications require source code publication or proprietary licensing. README states "Most features are free, even for commercial use" but does not clarify AGPL obligations. Legal review is mandatory before commercial deployment.

DEV.co evaluation signals

Editorial assessment — not user reviews. Directional, with an explicit confidence level.

SignalAssessment
MaintenanceActive
DocumentationAdequate
License clarityNeeds review
Deployment complexityModerate
DEV.co fitGood
Assessment confidenceHigh
Security considerations

No security audit results or vulnerability disclosure process documented in provided data. Local-first architecture reduces cloud attack surface but shifts responsibility to user infrastructure. AGPL-3.0 source availability aids code review. Self-hosted deployments must enforce TLS, firewall rules, and access controls. OpenAI API integration requires secure credential management.

Alternatives to consider

Obsidian

Proprietary, local-first, similar block-linking and Markdown support; no self-hosted option; free for personal use but commercial licensing required.

Logseq

Open-source (AGPL-3.0), similar PKM features, web-based UI; less mature plugin ecosystem; smaller community.

Notion

Cloud-first, SaaS, rich UI and team collaboration; closed-source; data residency and privacy concerns for regulated industries.

Software development agency

Build on siyuan with DEV.co software developers

SiYuan is a powerful choice for privacy-conscious, self-hosted PKM. Verify AGPL-3.0 licensing compliance with your legal team, assess infrastructure requirements, and test migration workflows before enterprise rollout.

Talk to DEV.co

Related open-source tools

Surfaced by semantic similarity across the DEV.co open-source index.

Related on DEV.co

Explore the category and the services that help you build with it.

siyuan FAQ

Can we use SiYuan commercially without source disclosure?
Only if deployment is strictly internal (not network-distributed to external users). Any commercial SaaS offering or distributed modification requires AGPL-3.0 source publication or proprietary licensing negotiation. Legal review required.
Is there a managed/hosted version?
No official SaaS. Self-hosting via Docker or Electron is mandatory. Third-party managed services may exist but are not listed in the provided data.
Does it support multi-user real-time collaboration?
Not documented as native feature. WebDAV/S3 sync supports eventual-consistency sharing; concurrent editing may cause conflicts. Designed for single/small offline-first teams.
What happens if I lose my data repo key?
README FAQ acknowledges this risk but solution not detailed in provided excerpt. Likely requires manual recovery or data reconstruction; backup strategy essential.

Custom software development services

DEV.co is a software development agency delivering custom software development services to companies building on open source. Our software developers and web developers design, integrate, and ship production systems — spanning web development, APIs, AI, data, and cloud. If siyuan is part of your mcp servers roadmap, our team can implement, customize, migrate, and maintain it.

Evaluate SiYuan for Your Knowledge Management Needs

SiYuan is a powerful choice for privacy-conscious, self-hosted PKM. Verify AGPL-3.0 licensing compliance with your legal team, assess infrastructure requirements, and test migration workflows before enterprise rollout.