APSM is a primarily interactive tool for managing groups of syncthing servers. Syncthing does not have central servers to configure, and instead each syncthing instance must be separately configured. For example adding a device or folders requires configuring each syncthing, although features like introducers and auto-accept can help.
APSM has a simple json file you configure with devices, folders and which devices sync the folders. You can also have arbitrary comments and other information.
{
"devices": {
"server1": { "id": "...", "#": "in the left cupboard"},
"laptop1": { "id": "...." },
"phone1": {"id": "..."},
"server2": {"id": "..."}
},
"folders": {
"taxes": { "id": "...", "sync": ["server1", "phone1"],
"photos": { "id": "...", "sync": ["server1", "server2", "laptop1"]
}
}With this file, APSM will update each syncthing you run against. They do not have to all be online or done at the same time.
- Updates device list and names
- Adds or removes folders
- Updates labels and device list for folders
Folder and path logic only works on Unix/Mac (not Windows)
Simultaneous config changes while the script is running will likely be overwritten, although backups are timely.
Only talking to the REST api. No XML is used, understood, or generated.
The code has no comments other than this doc. There are no tests as it was developed interactively.
Backups
Before making any change, a local file backup is made. You can easily restore, with checks to make sure it is the right file.
Generate configuration
Point at one or more syncthings and a config is generated merging the information from them. You can also provide an existing config which is used a base before merging.
This means you do most of your configuration using the syncthing gui.
Update configuration
Point at one or more syncthings and they will be updated to match the config
Folder rename / relocate
Checks folder name against label and lets you rename. The second time you get a "phone camera" folder, this helps greatly.
Find orphan folders
Checks the containing directories you currently use plus any on the command line to find subfolders with .stfolder in them but are not referenced by the syncthing config. Other folders are listed with ? prefix.
When a syncthing folder is removed, the disk folder is left in place. This way you can find and delete them.
You need Python 3, and the single apsm.py file. Invoke apsm.py with --help to get full option details. There are multiple sub-commands and relevant options.
Use --loglevel DEBUG to see the full details of what is going on. Log messages go to stderr.
Before making any change, a copy of the current configuration is saved in JSON format to this directory. The filename includes the device id and a timestamp. Use --help to see the default location.
In order to talk to syncthing an API key is needed which can be found in the syncthing xml config file, or in the web gui in Actions > Advanced.
You need to create a file with api keys listed. Blank lines and comments starting with # are ignored. Each api key is tried in order until one works.
This is an ip address and port number, and is the same address you enter in your browser to access the syncthing gui. The most common value is `127.0.0.1:8384'. The tool works with multiple endpoints, so you can make more available using ssh port forwarding or similar.