1
Step 1Open the server Apps tab
Select your VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.
Back to all templates
SiYuan
Application512MB+ RAM
Privacy-first personal knowledge management system with block-based editing
notesknowledge-managementblock-editorprivacy
Deploy SiYuan in 3 Steps
1
Connect Your VPS
Add your server credentials to Server Compass
2
Select SiYuan
Choose from our template library
3
Deploy & Configure
Fill in settings and click Deploy
No Docker knowledge required
Step-by-step deployment guide
Deploy SiYuan on a VPS with Server Compass
Use the SiYuan template in Server Compass to deploy a self-hosted privacy-first personal knowledge management system on your VPS, then verify the SiYuan web UI in a browser.
About 7 minutesBrowser verified
2
Step 2Choose an app template
Click New App and choose the template deployment path so Server Compass can load the built-in catalog.
3
Step 3Search for SiYuan
Use the template picker search to find SiYuan in the Server Compass template catalog.
4
Step 4Select the SiYuan template
Choose the SiYuan template. Server Compass fills the SiYuan image, host port, persistent workspace data volume.
5
Step 5Review the SiYuan settings
Confirm the app name and compose services. In this run, the app was named siyuan-demo and used host port 6806.
6
Step 6Deploy SiYuan
Review the generated environment values, confirm the port is available, and click Deploy Now.
7
Step 7Watch the deployment progress
Keep the deployment modal open while Server Compass uploads the compose file, pulls the SiYuan image, starts the container, and verifies the stack.
8
Step 8Confirm SiYuan is running
After deployment finishes, return to the Apps tab and confirm the SiYuan app is marked Running with its application URL available.
9
Step 9Open SiYuan in the browser
Open the application URL in a browser. The SiYuan web UI confirms the site is reachable.
After SiYuan Opens
- Enter the configured SiYuan auth code before production use.
- Configure HTTPS, auth code rotation, and user access before production use.
- Add a domain and HTTPS before exposing the knowledge workspace to users.
- Back up the SiYuan data volume before relying on it for production notes.
SiYuan deployment questions
What does the SiYuan template deploy?
It deploys SiYuan with a persistent data volume for notes.
Which port did the tutorial use?
The tutorial used host port 6806, which maps to the SiYuan web server on container port 80.
Why does the guide stop at the first-run web UI?
The tutorial verifies the clean first-run web UI because real notebooks, auth code, users, and access settings depend on the production server.
Should this become a blog post?
No. The deployment guide should live on the SiYuan template detail page and be linked from the reusable template deployment docs page.
Why Self-Host SiYuan?
SiYuan is a privacy-first knowledge management system with block-based editing, bidirectional links, and a graph view. Self-hosting ensures your personal knowledge base — which often contains your most valuable thinking and research — remains completely private.
Block-based editing with bidirectional links and graph visualization
Your personal knowledge base stays entirely private
Built-in spaced repetition for learning and retention
Local-first with web access when you need it
SQL-powered search across all your notes and blocks
SiYuan vs Alternatives
SiYuan vs Obsidian
Obsidian is local-only unless you pay for sync. SiYuan provides web access and sync built into the self-hosted package.
SiYuan vs Logseq
Logseq is outliner-focused. SiYuan offers richer block types and a more polished editing experience with built-in sync.
SiYuan vs Notion
Notion stores data on their servers. SiYuan is privacy-first with all data on your own infrastructure.
Why Deploy SiYuan with Server Compass?
Server Compass deploys SiYuan with persistent storage for your entire knowledge base and configures web access so you can reach your notes from any device through your server.
Download Server CompassAfter Deployment
After deploying SiYuan with Server Compass, complete these steps to finish setup
1
Access the web interface
2
Create your first notebook
3
Configure sync settings
Need help? Check out our documentation for detailed guides.
SiYuan FAQ
Common questions about self-hosting SiYuan
How do I deploy SiYuan with Server Compass?
Simply download Server Compass, connect to your VPS, and select SiYuan from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.
What are the system requirements for SiYuan?
SiYuan requires a minimum of 512MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.
Can I migrate my existing SiYuan data?
Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard SiYuan backup and restore procedures.
How do I update SiYuan to the latest version?
Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest SiYuan image will be pulled and deployed with zero downtime.
Is SiYuan free to self-host?
SiYuan is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.
Ready to Self-Host SiYuan?
Download Server Compass and deploy SiYuan to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass