Synchthing#

Synchthing is a powerful file synchronization tool. NextCloud can also do this, but Syncthing is nicer to work with servers and other people.

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest

SETUP#

Enabling syncthing#

Command:#

vlab set syncthing.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

syncthing
enable: True

Finalising changes:#

run: vlab update_one service=syncthing

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

Navigate to https://False/admin

Create an account with your desired username; as this is the first user, syncthing makes this account the administrator.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=syncthing to complete the changes

ACCESS#

syncthing (HTTPS) link: https://syncthing.vivumlab.xyz/ syncthing (HTTP) link: http://syncthing.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set syncthing.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

syncthing
https_only: True
Finalising changes:#

run: vlab update_one service=syncthing

AUTH#

Default: False
Options: True/False

Command:#

vlab set syncthing.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

syncthing
auth: True
Finalising changes:#

run: vlab update_one service=syncthing

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set syncthing.domain syncthing.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

syncthing
domain: syncthing.com
Finalising changes:#

run: vlab update_one service=syncthing

SUBDOMAIN#

Default: syncthing
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set syncthing.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

syncthing
subdomain: media
Finalising changes:#

run: vlab update_one service=syncthing

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set syncthing.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

syncthing
version: 2.7
Finalising changes:#

run: vlab update_one service=syncthing

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.