Setting up siyuan with docker and exposing it with cloudflare

Hi all!

I'm new to everything siyuan and docker related and struggling to understand how to set it up so my workspace can be accessible from any computer browser with any network. I've tried the docker image for siyuan but keep running into the issue of permission denied when trying to run the container. If someone can help me step by step, or even images or a quick video would be extremely helpful. My OS is windows 10 Home (or 11 if need a more recent one)

Thank you in advance! ☺️☺️❤️

Edit: change title regarding vpn to cloudflare. I read that cloudflare would be a much easier way to expose the container rather than using a vpn, if anyone has advice or tips - please feel free to share

    1 Operate
    vivien updated this article at 2024-09-26 01:58:51

    Welcome to here!

    Here we can learn from each other how to use SiYuan, give feedback and suggestions, and build SiYuan together.

    Signup About
    Please input reply content ...
    • vivien
      PRO Author

      Nice to see another fellow starter to siyuan!

    • MiscReply
    • glaucon1984 1 Up
      VIP Warrior

      If I understand correctly your scenario, you might find it much easier to just enable the option "Network Serving" from within SiYuan, under "Settings" -> "About".

      NOTE: Please remember to set a strong password under "Settings" -> "About" -> "Access authorization code".

      That will make your SiYuan instance accessible from a web browser in the IP address of your Surface, no need to run a VM with Ubuntu or deploy a container.

      The docker container is much more suitable for people that already have a setup at home running docker, probably a dedicated "home server", this makes it very easy for them to just add another container to their existing infrastructure.

      1 Reply
    • glaucon1984 1
      VIP Warrior

      You should give more details about your setup, what Linux distro, how did you install docker, what docker-compose.yml did you use to deploy the container, at what stage do you get that "permission denied" error, spinning up the container or while trying to access from the browser.

      If you are using the default Docker Compose suggested in GitHub, make sure the directory

      /siyuan/workspace
      

      exists, and that the permissions on that directory match the UID/GUID 1000:1000 specified. Or change accordingly.

      This is an example for the default values on the Docker Compose from GitHub:

      mkdir -p /siyuan/workspace
      chmod 1000:1000 /siyuan/workspace
      

      You might want to run chmod with "-R" for the parent directory /siyuan. It's hard to guess your problem with the little information you have provided.

      1 Reply
    • glaucon1984
      VIP Warrior

      If you want to access a machine in your home network from public internet you need a couple of things:

      • NAT, or more specifically, PAT (Port Address Translation). This has to be configured in your router and it will map the internal IP and port of the service you want published to the internet to a port on your public IP address. You must check your router manual to find out how to do this.
      • If your IP address is not static (most consumer-grade Internet services use a dynamic IP address) you probably will want to use a dynamic DNS service. Duck DNS is free and there are numerous solutions that will automate the process of updating your public IP address and map it to a domain name.

      With this you will expose SiYuan on public internet, for anybody to try and break the SiYuan password. So set a strong one. I personally put my infrastructure behind Authelia, which adds another layer of authentication, requiring me to grant access from an app in my smartphone (Duo).

      On top of that, all the traffic between any browser and SiYuan won't be encrypted, this means, HTTP instead of HTTPS, so the traffic can be inspected in transit. I personally use a reverse proxy, NGINX, to make the traffic secure with the use of signed certificates.

      As I told Eric, these are very advanced topics which are probably beyond the scope of this forum, but you have some key words to google about if you want to learn more about these topics.

    • Visit all replies