https://github.com/lu0/syncthing-config
My config files for Syncthing, a continuous file synchronization program. Only non-sensitive data (folder and device IDs).
https://github.com/lu0/syncthing-config
configuration-files file-synchronization linux syncthing
Last synced: about 1 month ago
JSON representation
My config files for Syncthing, a continuous file synchronization program. Only non-sensitive data (folder and device IDs).
- Host: GitHub
- URL: https://github.com/lu0/syncthing-config
- Owner: lu0
- Created: 2020-08-10T08:15:55.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-12T05:00:32.000Z (about 5 years ago)
- Last Synced: 2025-06-07T13:43:18.327Z (about 1 year ago)
- Topics: configuration-files, file-synchronization, linux, syncthing
- Language: Shell
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# syncthing-config
This repo tracks the [Syncthing](https://github.com/syncthing/syncthing) config files of my phone and my laptops.
- [What do I sync?](#what-do-i-sync)
- [Home directory](#home-directory)
- [Phone](#phone)
- [Installation](#installation)
- [Setup](#setup)
- [Desktop config](#desktop-config)
- [Android config](#android-config)
- [Run at startup](#run-at-startup)
- [Sensitive files and folders to be ignored by git](#sensitive-files-and-folders-to-be-ignored-by-git)
## What do I sync?
I sync some folders of my home directory between my laptops, and some folders of my phone.
### Home directory
Usual folders:
* Documents
* Home
* Downloads
* Music
* Pictures
* Templates
* Videos
Custom folders:
* Artwork
* Code
* Mobile
### Phone
Current Android versions only grants Syncthing read-only access to the SD card, so I store all my data in the internal storage. I set dummy folders anyways in case Android 11 allows Syncthing to write to the SD card.
* DCIM
* Pictures (created by apps)
* Downloads
* Whatsapp media
* Voice recordings
* Backup folder of syncthing
## Installation
Get the latest stable release.
```zsh
curl -s https://api.github.com/repos/syncthing/syncthing/releases/latest \
| grep "browser_download_url.*tar.gz" | grep "linux-amd64" \
| cut -d '"' -f 4 \
| wget -i - -O syncthing-latest.tar.gz
```
Extract its contents and create a local symlink to the binary.
```zsh
mkdir -p syncthing-latest
tar -xf syncthing-latest.tar.gz -C syncthing-latest/ --strip-components=1
rm syncthing-latest.tar.gz
ln -srf syncthing-latest/syncthing ~/.local/bin/
```
## Setup
Syncthing [overwrites the config file](https://github.com/syncthing/syncthing/issues/6628) instead of editing it, so neither symlinks nor hardlinks from the config files to the repo will work. A workaround to track those files is to mount their parent directories in folders created inside the repo, stage the config.xml files and use the .gitignore to ignore files containing sensitive data.
The following steps uses paths of my machine for sake of example.
### Desktop config
Syncthing store the config files in ```~/.config/syncthing/```, mount this folder inside the repo to track its contents.
```zsh
mkdir -p ~/code/syncthing-config/desktop-config/
sudo mount --bind ~/.config/syncthing/ ~/code/syncthing-config/desktop-config/
```
If using Nemo, run the following script to hide "link" emblems and show Syncthing emblems on the synced folders.
```zsh
./emblems.sh
```
In case you want to restore the default emblems, run:
```zsh
./restore-emblems
```
### Android config
Use "Import and Export" in the app settings to store a backup of the config files in ```[internal data]/backups/syncthing/```. I sync this folder with my computer in ```~/mobile/DEVICE/int-syncthing```.
```zsh
mkdir -p ~/code/syncthing-config/android-config/
sudo mount --bind ~/mobile/ga50/int-syncthing/ ~/code/syncthing-config/android-config/
```
### Run at startup
If everything works as intended, edit `/etc/fstab` with:
```zsh
...
/home/USER/.config/syncthing/ /home/USER/code/syncthing-config/desktop-config/ none user,nodev,x-gvfs-hide,bind 0 0
/home/USER/mobile/DEVICE/int-syncthing/ /home/USER/code/syncthing-config/android-config/ none user,nodev,x-gvfs-hide,bind 0 0
```
### Sensitive files and folders to be ignored by git
The ```.gitignore``` contains the list of files and folders that [must not be tracked](https://docs.syncthing.net/users/security.html#protecting-your-syncthing-keys-and-identity):
* key.pem
* cert.pem
* https-key.pem
* https-cert.pem
* csrftokens.txt
* sharedpreferences.dat
* index-v0.14.0.db
Only folder and device IDs [can be tracked](https://docs.syncthing.net/users/faq.html#should-i-keep-my-device-ids-secret), those IDs are stored in the ```config.xml``` files. However, these files include API keys. What I did was commit blank ```config.xml``` files, then pasted and committed the lines with non-sensitive data and lastly I added the sensitive data to the files but didn't commit them. I mantain the repo using a pre-commit hook to avoid commiting lines with API keys:
```zsh
ln -srf pre-commit .git/hooks/
```
Make sure to unstage lines containing sensitive data.