siyuan-note/siyuan Installation Guide

⚡

Automated Install (Recommended)

Quick installation instructions for siyuan-note/siyuan. This is the fastest way to complete project installation and setup.

Install via curl

curl -fsSL https://hexmos.com/ipm-install | bash && 
ipm i siyuan-note/siyuan

Install via PowerShell

iwr https://hexmos.com/ipm-install-ps -UseBasicParsing | iex; 
ipm i siyuan-note/siyuan

Install via npx

npx @hexmos/ipm i siyuan-note/siyuan

Prerequisites

Python

language

Version: >=3.6.0

pip

package_manager

Package installer for Python.

Git

system_tool

Version: 2.30.1

Docker

system_package

Containerization platform for development and deployment.

Manual Installation Methods

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

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

Post Installation Steps

Start the server using the command: `npm start`
Run database migrations using the command: `npx sequelize db:migrate`

← Back to library All Installation Guides