XZ

Xiao Z's blog

Learn, build, share

Deploy Siyuan Note with Docker for Web Access

docker deploy siyuansiyuan note web accesssiyuan docker configurationsiyuan note securitysiyuan note browser
Published·Modified·

The previous article shared Siyuan Note, a local-first note-taking software supporting Markdown WYSIWYG. Following up on that, this article continues to share how to deploy Siyuan Note via Docker and access it through a browser.

What Problem Does Docker Deployment of Siyuan Note Solve?

Official information regarding Docker deployment is scarce, and online resources do not clearly explain the differences between Docker deployment and local installation of Siyuan Note. Initially, I thought Docker deployment provided a server-side solution to sync local data. However, after deployment, I discovered that Docker deployment is also a client (or node), primarily designed for users who do not wish to install a client, allowing them to access via a browser. Therefore, Docker deployment does not solve the synchronization problem.

Docker Deployment of Siyuan Note

If you have already installed Docker, simply copy and run the following command:

docker run -d \
  -v /data/apps/siyuan/workspace:/siyuan/workspace \
  -p 6806:6806 \
  -u $(id -u):$(id -g) \
  b3log/siyuan:v1.9.0 \
  --workspace=/siyuan/workspace/

You need to modify the following:

  • Change /data/apps/siyuan/workspace to your own directory. Only modify this one directory; do not change others.
  • v1.9.0: This is the Siyuan Note version. You can omit it, and the default latest tag will be used. However, note that using latest on domestic Docker mirrors may pull an outdated version.
  • --workspace: Refers to the Siyuan Note workspace directory, which generally does not need modification.

You can check specific tags at: https://hub.docker.com/r/b3log/siyuan/tags.

Access and Configuration

After installation, access via http://IP:6806. The default interface is in English. Press the shortcut Alt + P to open Settings - Appearance - Language - Select Chinese to switch.

By default, all users can access, which is not secure. Continue pressing Alt + P to open Settings - About - Access Authorization Code - Set an access authorization code.

Once the access authorization code is enabled, you will need to enter the code next time you access.

Other settings are the same as the client. You can refer to my previous article Siyuan Note, a local-first note-taking software supporting Markdown WYSIWYG.

Summary

  1. Docker deployment of Siyuan Note allows browser access, suitable for those who do not want to install a client.
  2. Docker deployment does not solve synchronization problems; you still need to sync manually or purchase official cloud services.
  3. When deploying Siyuan Note via Docker, please务必 set an "Access Authorization Code" to avoid significant security risks.
  4. The web access experience for Siyuan Note is basically consistent with the client, but mobile browser access is not satisfactory.

Siyuan Note Official Website: https://b3log.org/siyuan/