---
title: "Deploy SiYuan"
description: "SiYuan privacy-first knowledge base: pinned release, data on a volume"
category: "Other"
url: https://railway.com/deploy/siyuan-3
---

# Deploy SiYuan

SiYuan privacy-first knowledge base: pinned release, data on a volume

**[Deploy SiYuan on Railway](https://railway.com/template/siyuan-3)**

Machine-readable deploy manifest (JSON, validated by TemplateCI): https://railway.com/deploy/siyuan-3/manifest.json

- **Creator:** Agaz Self-Host
- **Category:** Other

## Template content

### SiYuan https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/png/siyuan.png

- **Source:** https://github.com/aalfath/siyuan-railway-template
- **Health check:** /api/system/version
- **Public domain:** Yes

## Documentation

# Deploy and Host SiYuan on Railway

SiYuan is an open-source, privacy-first knowledge base and note-taking app. You write in a Markdown WYSIWYG editor made of blocks that you can reference, embed and link in both directions. It also has databases, flashcards, full-text search and an API. The project is licensed AGPL-3.0.

## About Hosting SiYuan

This template runs one service built from the public repo aalfath/siyuan-railway-template. The repo's Dockerfile pins the official b3log/siyuan image at v3.8.10 by digest. A Railway volume at /siyuan/workspace holds all notebooks, assets, settings and snapshots, so your data survives restarts and redeploys. A 32-character lock-screen password is generated at deploy, and the start script refuses to run without one. The health check calls /api/system/version, which answers without a login. To log in, copy SIYUAN_ACCESS_AUTH_CODE from the service's Variables tab, open the public domain and enter it. Run one replica only.

## Common Use Cases

* A private notebook and personal wiki you can reach from any browser
* A block-based knowledge base with bidirectional links, embeds and databases
* Spaced-repetition flashcards and research notes kept on storage you control

## Dependencies for SiYuan Hosting

* The official b3log/siyuan image (v3.8.10, pinned by digest)
* A Railway volume mounted at /siyuan/workspace

### Deployment Dependencies

* SiYuan source and docs: https://github.com/siyuan-note/siyuan
* Release notes for v3.8.10: https://github.com/siyuan-note/siyuan/releases/tag/v3.8.10
* Template repo and changelog: https://github.com/aalfath/siyuan-railway-template

### Implementation Details

* Variables: SIYUAN_ACCESS_AUTH_CODE (generated lock-screen password), PORT (6806, don't change it) and TZ (optional, defaults to UTC). Change the password by editing the variable and redeploying.
* SIYUAN_ACCESS_AUTH_CODE_BYPASS is ignored, so the instance always stays behind the lock screen.
* Upstream limits of Docker hosting: browser use only (the desktop and mobile apps can't connect to it), no PDF, HTML or Word export, and no Markdown file import.
* Updates: when the template repo moves to a new SiYuan release, Railway shows an "update available" notice on your project. Read the repo's CHANGELOG.md, export or snapshot your data in SiYuan, then apply the update. The volume is kept.

## Why Deploy SiYuan on Railway?


Railway is a singular platform to deploy your infrastructure stack. Railway will host your infrastructure so you don't have to deal with configuration, while allowing you to vertically and horizontally scale it.

By deploying SiYuan on Railway, you are one step closer to supporting a complete full-stack application with minimal burden. Host your servers, databases, AI agents, and more on Railway.



## Similar templates

- [Rocky Linux](https://railway.com/deploy/rocky-linux) — Hosted Rocky Linux 9 workspace with SSH and persistent storage. 🚀
- [Foundry Virtual Tabletop](https://railway.com/deploy/X5tR6G) — Self-hosted virtual tabletop for role-playing games (license required)
- [Double Commander in your browser](https://railway.com/deploy/double-commander-in-your-browser) — The Double Commander file manager in the cloud, from any device

Open this page in a browser: https://railway.com/deploy/siyuan-3
