Skip to content

Repository files navigation

Syncthing

Build Status Last Commit

Syncthing replaces proprietary sync and cloud services with something open, trustworthy and decentralized. Your data is your data alone and you deserve to choose where it is stored, if it is shared with some third party and how it's transmitted over the Internet.

Port 8384
Registry ghcr.io/daemonless/syncthing
Source https://github.com/syncthing/syncthing
Website https://syncthing.net/

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Alternative build.
pkg FreeBSD Quarterly. Uses stable, tested packages. Production stability.
pkg-latest FreeBSD Latest. Rolling package updates. Staying current.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
  syncthing:
    image: "ghcr.io/daemonless/syncthing:latest"
    container_name: syncthing
    volumes:
      - "/path/to/containers/syncthing:/config"
    ports:
      - "8384:8384"
      - "22000:22000"
      - "22000:22000"
      - "21027:21027"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=syncthing

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  syncthing:
    name: syncthing
    options:
      - container: 'args:--pull'
      - expose: '8384:8384 proto:tcp'
      - expose: '22000:22000 proto:tcp'
      - expose: '22000:22000 proto:udp'
      - expose: '21027:21027 proto:udp'
    volumes:
      - syncthing: /config
volumes:
  syncthing:
    device: '/path/to/containers/syncthing'

Makejail:

# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/syncthing:${tag}

Save the files above, then run appjail-director up.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Podman CLI

podman run -d --name syncthing \
  -p 8384:8384 \
  -p 22000:22000 \
  -p 22000:22000 \
  -p 21027:21027 \
  -v /path/to/containers/syncthing:/config \
  ghcr.io/daemonless/syncthing:latest

Save as run.sh, then run sh run.sh.

AppJail

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o expose="8384:8384 proto:tcp" \
  -o expose="22000:22000 proto:tcp" \
  -o expose="22000:22000 proto:udp" \
  -o expose="21027:21027 proto:udp" \
  -o fstab="/path/to/containers/syncthing /config <pseudofs>" \
  ghcr.io/daemonless/syncthing:latest syncthing

Save the files above, then run sh run.sh.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Bastille

Warning

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  syncthing:
    name: syncthing
    image: "ghcr.io/daemonless/syncthing:latest"
    network:
      - mode: host
    volumes:
      - "/path/to/containers/syncthing:/config"

Save as bastille-compose.yml, then run bastille up. Or via CLI:

bastille create -O \
  --volume /path/to/containers/syncthing /config \
  syncthing ghcr.io/daemonless/syncthing:latest inherit

Ansible

- name: Deploy syncthing
  containers.podman.podman_container:
    name: syncthing
    image: "ghcr.io/daemonless/syncthing:latest"
    state: started
    restart_policy: always
    ports:
      - "8384:8384"
      - "22000:22000"
      - "22000:22000"
      - "21027:21027"
    volumes:
      - "/path/to/containers/syncthing:/config"

Save as syncthing-deploy.yaml, then run ansible-playbook syncthing-deploy.yaml.

Access at: http://localhost:8384

Parameters

Volumes

Path Description
/config Configuration and data directory

Ports

Port Protocol Description
8384 TCP Web UI
22000 TCP Sync protocol (TCP/UDP)
22000 UDP Sync protocol (TCP/UDP)
21027 UDP

Architectures: amd64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.1


Need help? Join our Discord community.

About

Syncthing replaces proprietary sync and cloud services with something open, trustworthy and decentralized. Your data is your data alone and you deserve to choose where it is stored, if it is shared with some third party and how it's transmitted over the Internet.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages