How to Self-Host Syncthing on a VPS (Complete Guide)

Self-hosting applications like Syncthing on a VPS can significantly enhance your file synchronization and sharing experience. It allows you to maintain complete control over your data while also benefiting from the flexibility and power of cloud infrastructure. In this guide, we will walk through the process of installing and setting up Syncthing on a VPS, primarily using Docker to ensure a streamlined deployment.

Choosing a VPS Provider

Before we dive into the installation, you need to select a VPS provider. Below is a comparison of some top VPS providers that cater to developers and homelabbers alike.

You can explore more options with a full VPS comparison.

Step 1: Setting Up Your VPS

1. Select a VPS provider from the options above that suits your needs.

2. Sign up and create an account with your chosen provider.

3. Deploy a new instance with your preferred operating system. Ubuntu (20.04 or later) is recommended for its ease of use and community support.

4. Access your VPS via SSH. You can do this using a terminal on Linux or macOS, or tools like PuTTY for Windows. Run the command replacing user and your_ip with your VPS credentials:

   ssh user@your_ip

Step 2: Installing Docker

Docker simplifies the process of deploying applications consistently across various environments. To install Docker on your VPS, follow these steps:

1. Update your package index:

   sudo apt update

2. Install required packages:

   sudo apt install apt-transport-https ca-certificates curl software-properties-common

3. Add Docker’s official GPG key:

   curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

4. Add the Docker APT repository:

   sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"

5. Install Docker:

   sudo apt update
   sudo apt install docker-ce

6. Check Docker installation:

   sudo systemctl status docker

The output should indicate that Docker is active and running.

Step 3: Running Syncthing on Docker

Now, we will run Syncthing in a Docker container. The following commands will help you get up and running quickly:

1. Create a directory for Syncthing configuration:

   mkdir -p ~/syncthing/config

2. Run the Syncthing Docker container:

   docker run -d \
     --name=syncthing \
     --restart=always \
     -v ~/syncthing/config:/var/syncthing/config \
     -e PUID=1000 -e PGID=1000 \
     -p 8384:8384 \
     -p 22000:22000 \
     -p 21027:21027/udp \
     syncthing/syncthing

• Explanation: This command starts the Syncthing container in detached mode (-d), sets the necessary environment variables for user permissions, maps local ports to the container, and ensures the container restarts automatically on failure or system reboot.

3. Access Syncthing: Open your web browser and navigate to http://your_ip:8384 to access the Syncthing interface.

Step 4: Configuring Syncthing

Once you access the Syncthing interface, you’ll need to complete some essential configurations:

• Device Setup: You may need to add devices by noted device IDs, which are uniquely generated for each Syncthing instance.
• Folder Sharing: Create folders and share them with your devices as needed.
• Advanced Settings: Explore advanced settings for features like file versioning, ignore patterns, and notifications.

FAQs

What is Syncthing and how does it work?

Syncthing is an open-source continuous file synchronization program that allows you to share and sync files between devices over the internet or local networks. It operates in a peer-to-peer manner, ensuring that your data remains private and secure. Unlike centralized services, with Syncthing, only the devices you allow can access your files. Each device in the network remains in sync automatically, allowing for seamless collaboration or backup solutions.

Why should I self host Syncthing instead of using a cloud service?

Self-hosting Syncthing provides greater control over your data and settings. By running Syncthing on a VPS, you avoid privacy concerns associated with data being stored on cloud service providers. Additionally, you can customize your installation, integrate it with other self-hosted applications, and benefit from your own server’s resources, potentially saving on subscription fees in the long term.

Can I run Syncthing on a low-resource VPS?

Yes, Syncthing is lightweight and can run efficiently on low-resource VPS instances. Providers like Hetzner Cloud offer budget-friendly options (starting at 4.15 EUR/mo), making it feasible to run Syncthing alongside other applications on a single VPS. Just ensure your VPS has enough disk space and bandwidth to handle the files being synchronized.

By following these steps, you should now have Syncthing installed and configured on your VPS, enabling you to synchronize files effortlessly across your devices. For further exploration of VPS options, refer to our full VPS comparison. Happy self-hosting!