Optional extra parameters to be added to the extra parameters section of the container's options page:

 

 

--servePath

Used to specify the server path, the default value is window.location.hostname+":6806".

For example, when you need to access through a domain name, please set the value to yourdomain.com. Leave the port blank to indicate that the protocol default port is used, and the NGINX reverse proxy needs to be requested to port 6806.

 

--resident

After specifying with --resident=true, the kernel will be resident in memory, the default is true.

After set to false, the list of active sessions will be checked every 30 seconds, and the kernel process will be exited if there are no active sessions.

 

--readonly

After specifying with --readonly=true, the kernel will run in read-only mode and all write operations will be prohibited.

 

--accessAuthCode

Used to specify the browser access authentication password, which will overwrite the authCode in conf.json after setting.

 

--ssl

After using --ssl=true, https and wss protocols will be used for serving.

Edited October 27, 20214 yr by jabajames

Hello,

 

can you help me to install and run SiYuan on Unraid, i opend already a thread.

But its german, hope you can help me

 

 

Greetings

 

Has anyone figured out how to launch this?

Hi,

after a lot of struggles, I found out how to get the docker working on Unraid.

You set your parameters, then switch to the advanced view.

 

Take the Container Path from NOTES

 

In the 'Post Arguments' field, add:

--workspace=CONTAINER_NOTES_PATH --accessAuthCode=YOUR_WEBUI_PASSWORD

 

in my case:

 

--workspace=/root/Documents/SiYuan/data/ --accessAuthCode=pass123

 

Normally, you should have a working Siyuan.

On 10/13/2024 at 2:17 PM, Itsatsu said:

Hi,

after a lot of struggles, I found out how to get the docker working on Unraid.

You set your parameters, then switch to the advanced view.

 

Take the Container Path from NOTES

 

In the 'Post Arguments' field, add:

--workspace=CONTAINER_NOTES_PATH --accessAuthCode=YOUR_WEBUI_PASSWORD

 

in my case:

 

--workspace=/root/Documents/SiYuan/data/ --accessAuthCode=pass123

 

Normally, you should have a working Siyuan.

You the best! works very well

Thanks, it really works! I have been struggling for more than one week.

On 10/13/2024 at 11:17 PM, Itsatsu said:

Hi,

after a lot of struggles, I found out how to get the docker working on Unraid.

You set your parameters, then switch to the advanced view.

 

Take the Container Path from NOTES

 

In the 'Post Arguments' field, add:

--workspace=CONTAINER_NOTES_PATH --accessAuthCode=YOUR_WEBUI_PASSWORD

 

in my case:

 

--workspace=/root/Documents/SiYuan/data/ --accessAuthCode=pass123

 

Normally, you should have a working Siyuan.

Thank you so much!

 

This was very annoying.

 

This worked for me.

 

They need to fix their default template.

The previous advice doesn't work for me as the docker user created doesn't have access to the /root/ folders it defaults to putting appdata in. The Docker can start now, but it's not writing to appdata, but inside the docker volume. I modified the template as follows in advanced mode by adding three environment variables and removing one.

Web UI: 6806

Container Port: 6806

Workspace Mount: /mnt/user/appdata/siyuan

Container Path: /siyuan/workspace/

Location on Unraid for data

Workspace Path: /siyuan/workspace/

Container Variable: SIYUAN_WORKSPACE_PATH

Name of the workspace mount

Auth Code:

Container Variable: SIYUAN_ACCESS_AUTH_CODE

Password (optional)

Disable Auth Code: True

Container Variable: SIYUAN_ACCESS_AUTH_CODE_BYPASS

Edited December 10, 2025Dec 10 by thespooler

Can confirm, the container was created incorrectly and must be modified to work, lest you risk losing all your data on the next docker update.