Deploy SiYuan on Railway

What is this template

This template deploys SiYuan, an open-source, privacy-focused personal knowledge management system, to Railway.app with just one click.

SiYuan is designed for individuals who value data ownership and powerful knowledge organization. Think of it as your second brain that helps you connect thoughts and manage information.

Key Features

Block-based Editing: Create and manipulate content in discrete blocks, similar to Notion or Roam Research
Bidirectional Linking: Connect notes and concepts with powerful bidirectional links
Local-first Philosophy: Your data stays on your device by default
Markdown Support: Write in familiar Markdown syntax with extended capabilities
Full-text Search: Quickly find anything in your knowledge base
Math & Diagrams: Support for LaTeX math formulas and various diagram types
Cross-platform: Available on Windows, macOS, Linux, Android, and iOS
API Access: Programmatic access to your data through RESTful APIs

Quick Start Guide

Click the "Deploy on Railway" button at the top of this page
Leave all variables and settings as their defaults
Wait for your new instance to deploy (this typically takes 2-3 minutes)
Once deployed, copy the SIYUAN_AUTH_CODE variable that Railway generated for you from the variables tab in your SiYuan service.
Navigate to your new SiYuan instance at the URL provided by Railway. This URL will be in your SiYuan service's settings tab.
Use the auth code to log in when prompted
Start building your knowledge base!

Optional Variables

Variable	Description	Default
`SIYUAN_AUTH_CODE`	Authentication code for accessing your SiYuan instance	Auto-generated secure string
`TZ`	Timezone for your SiYuan instance	`UTC`

Timezone Configuration

The TZ variable allows you to set the system timezone for your SiYuan instance. This affects how timestamps are displayed throughout the application.

Examples of valid timezone values:

America/Vancouver (for Pacific Time)
America/Toronto (for Eastern Time)
Europe/London
Asia/Tokyo

Changing this variable only affects the system time display and does not impact any functionality.

Project Structure & Services

This template uses a straightforward architecture:

SiYuan Application: Deployed using the official SiYuan Docker image
Persistent Storage: Railway volume mounted to /siyuan/workspace/ to ensure your data persists across redeploys and upgrades
Automatic Updates: When new versions of SiYuan are released, you can easily redeploy to get the latest features

The Docker container exposes port 6806, which Railway automatically maps to a public URL for you to access.

Additional Resources

Developed and maintained by the SiYuan community. Railway template by Mykal and team.