Video coming soon…

🛠️ Setup SiYuan — Local-First Block-Based Notes

Deploy SiYuan on Ubuntu with Docker — a privacy-first, block-based knowledge base with bidirectional links, protected by a generated access auth code, on port 6806.

⚠️ This script is provided for demo and testing purposes only. Not intended for production use.

📦 Resources & Setup Scripts

Grab the automated bash script from GitHub to follow along with the video.

Automated install script — one command deploys SiYuan on port 6806 with a generated access auth code protecting your workspace.
View on GitHub

Quick Install:

wget https://raw.githubusercontent.com/mhmdali94/Docker/main/tools/siyuan/siyuan-ubuntu.sh
chmod +x siyuan-ubuntu.sh
sudo bash siyuan-ubuntu.sh

Tutorial Steps

1 Download the Script

wget https://raw.githubusercontent.com/mhmdali94/Docker/main/tools/siyuan/siyuan-ubuntu.sh

2 Make it Executable

chmod +x siyuan-ubuntu.sh

3 Run the Installer

The script installs Docker if needed, generates a 12-character access auth code, and starts b3log/siyuan on port 6806 with your notes stored in the ./workspace volume.

sudo bash siyuan-ubuntu.sh

4 Enter the Access Auth Code

Open SiYuan — the installer prints the generated access auth code, which you enter to unlock the workspace:

http://<your-server-ip>:6806

Ports Used

PortPurpose
6806Web UI (host → container 6806) — guarded by access auth code
accessAuthCode12-character code, generated — save it or you are locked out
./workspaceAll notes as files

Overview

Why Use It

When You Need It

    Who Should Use It

      Real Use Cases

        Main Features

          How to Use After Installation

            Security Best Practices

              Ports and Firewall Notes

              Backup and Maintenance

                Common Mistakes

                  Troubleshooting

                    Alternatives

                    When Not to Use It

                    PrismaTechWork Professional Help

                      Contact Us

                      Frequently Asked Questions