Back to all templates
Syncthing logo

Syncthing

Infrastructure128MB+ RAM

Continuous file synchronization between devices

syncfilesp2p

Deploy Syncthing in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select Syncthing

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy Syncthing on a VPS with Server Compass

Use the Syncthing template in Server Compass to deploy continuous file synchronization on your VPS, then verify the web UI in a browser.

About 10 minutesBrowser verified
1
Step 1

Open the server Apps tab

Select the tutorial-vps VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating a Syncthing app
2
Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template
3
Step 3

Search for Syncthing

Use the template picker search to find Syncthing in the Server Compass template catalog.

Searching for Syncthing in the Server Compass template picker
4
Step 4

Select the Syncthing template

Choose the Syncthing template. Server Compass fills the web service, persistent config volume, web UI port, and sync/discovery ports.

Syncthing template selected in Server Compass
5
Step 5

Review the Syncthing settings

Confirm the app name and compose service. In this run, the app was named syncthing-demo and used host port 8384 for the web UI.

Reviewing Syncthing project settings and compose service
6
Step 6

Deploy Syncthing

Review the generated compose settings, confirm the Syncthing web UI and sync ports are available, and click Deploy.

Reviewing Syncthing environment variables and ports before deployment
7
Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the Syncthing image, starts the container, and verifies the stack.

Server Compass deploying the Syncthing template on the VPS
8
Step 8

Confirm Syncthing is running

After deployment finishes, return to the Apps tab and confirm the Syncthing app is marked Running with its application URL available.

Syncthing template running in the Server Compass Apps tab
9
Step 9

Open Syncthing in the browser

Open the application URL in a browser. The Syncthing web UI confirms the synchronization service is reachable.

The deployed Syncthing web UI loaded in a browser

After Syncthing Opens

  • Set a strong Syncthing GUI username and password before exposing the web UI beyond trusted networks.
  • Use a VPN, IP allowlist, firewall rule, or authenticated reverse proxy for production access.
  • Add trusted devices and share only the folders that should synchronize with the VPS.
  • Review firewall rules for 22000 TCP/UDP and 21027 UDP if you need direct device discovery and sync traffic.
  • Back up the Syncthing config volume before replacing the VPS or moving the deployment.
  • Keep the Syncthing image updated for dependency and security fixes.

Verified Result

The Syncthing web interface loaded successfully and displayed the device and folder dashboard.

Syncthing deployment questions

What does the Syncthing template deploy?

It deploys the Syncthing container with a persistent config volume, a public web UI port, and the standard sync/discovery ports.

Which port did the tutorial use?

The tutorial used host port 8384, which maps to the Syncthing web UI on container port 8384. The template also exposes 22000 TCP/UDP and 21027 UDP for synchronization and discovery.

Should I expose the Syncthing GUI publicly?

Prefer a VPN, IP allowlist, or authenticated reverse proxy. If the GUI is reachable from the public internet, set a strong GUI username and password immediately.

Should this become a blog post?

No. The deployment guide should live on the Syncthing template detail page and be linked from the reusable template deployment docs page.

Command Line Setup

Install Syncthing Manually

Set up Syncthing yourself using Docker Compose and the command line.

1

Establish SSH Connection

Connect to your remote server using SSH. Make sure you have your server credentials ready.

terminal
# Log into your server
ssh root@<your-server-ip>

# If using key-based auth
ssh -i ~/.ssh/my-key root@<your-server-ip>

First time? Docker not installed? Run: curl -fsSL https://get.docker.com | sh

2

Create Project Directory

Set up a directory to store your Docker configuration.

terminal
# Create and navigate to project directory
mkdir -p ~/apps/syncthing
cd ~/apps/syncthing
3

Configure Docker Compose

Add this configuration to your docker-compose.yml file:

docker-compose.yml
services:
  syncthing:
    image: lscr.io/linuxserver/syncthing:latest
    ports:
      - "8384:8384"
      - "22000:22000/tcp"
      - "22000:22000/udp"
      - "21027:21027/udp"
    environment:
      - PUID=1000
      - PGID=1000
    volumes:
      - syncthing_config:/config
    restart: unless-stopped

volumes:
  syncthing_config:
Configuration Options
PORTWeb UI port(default: 8384)
4

Start the Services

Execute the deployment and check the container status.

terminal
# Deploy the application
docker compose up -d

# Check container health
docker compose ps

# Monitor logs
docker compose logs -f --tail=100
5

Allow Incoming Connections

Enable network access by updating your firewall rules.

terminal
# Allow the application port through firewall
sudo ufw allow 8384/tcp
sudo ufw reload

# Access your app at:
# http://your-server-ip:8384
Skip the Terminal

Too complicated? Let Server Compass handle it.

No terminal needed. Deploy Syncthing through a visual dashboard with automatic configuration.

  • Intuitive dashboard
  • Deploy in 3 minutes
  • Free SSL included
  • Blue-green deploys
  • Real-time logs
  • Version history
Download Server Compass$29 one-time • Lifetime license

After Deployment

After deploying Syncthing with Server Compass, complete these steps to finish setup

1

Access web UI

2

Set up GUI password

3

Add devices and folders to sync

Need help? Check out our documentation for detailed guides.

Syncthing FAQ

Common questions about self-hosting Syncthing

How do I deploy Syncthing with Server Compass?

Simply download Server Compass, connect to your VPS, and select Syncthing from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for Syncthing?

Syncthing requires a minimum of 128MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing Syncthing data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Syncthing backup and restore procedures.

How do I update Syncthing to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Syncthing image will be pulled and deployed with zero downtime.

Is Syncthing free to self-host?

Syncthing is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Ready to Self-Host Syncthing?

Download Server Compass and deploy Syncthing to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass