https://github.com/terminalnetwork/syncthing-hooks
Runs shell scripts when syncthing folders get updated. 🦉🕗
https://github.com/terminalnetwork/syncthing-hooks
hooks syncthing watcher
Last synced: 6 months ago
JSON representation
Runs shell scripts when syncthing folders get updated. 🦉🕗
- Host: GitHub
- URL: https://github.com/terminalnetwork/syncthing-hooks
- Owner: terminalnetwork
- License: unlicense
- Created: 2020-03-17T21:10:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-03T05:23:06.000Z (over 2 years ago)
- Last Synced: 2024-11-05T23:41:31.416Z (11 months ago)
- Topics: hooks, syncthing, watcher
- Language: JavaScript
- Homepage:
- Size: 35.2 KB
- Stars: 32
- Watchers: 2
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# syncthing-hooks
Run shell scripts via event hook files (similar to Git hooks) when changes are detected in a [Syncthing](https://syncthing.net/) folder.
## Prerequisites
[Node.js >= 10](https://nodejs.org/en/)
## Installation
```sh
npm i -g syncthing-hooks
```
## Usage
You can simply run the watcher process via:
```sh
API_KEY=mykey syncthing-hooks
```
Don't forget to substitute `mykey` with your syncthing API key, which can be found in the settings in the GUI.
If Syncthing runs on another host or listens to a non-default port, you can specify an URL by using `ST_URL`.
Note that this URL has to include the protocol, hostname, port and path, e.g.:
```
ST_URL=http://:8384/rest/events
```
It won't install itself as a daemon by default, however. In order to run it as a service, it is recommended to install [pm2](https://pm2.keymetrics.io/):
```sh
npm i -g pm2
```
You can then register it as a daemon via:
```sh
pm2 start "API_KEY=mykey syncthing-hooks" --name sthooks
```
To create the daemon automatically on startup, consult [this documentation](https://pm2.keymetrics.io/docs/usage/startup/).
You can follow the output of your hooks by using:
```sh
pm2 logs
```
## Hooks
Create a folder in your home directory called `.syncthing-hooks`.
A different directory can be set using `ST_HOOK_ROOT`.
Each hook is a file with the following naming scheme:
`folder-name-delay`
The folder name is the 11 character unique string found in the syncthing GUI. The delay is a string (anything parseable by the [ms module](https://github.com/zeit/ms)) indicating the idle time after an event, so that hooks aren't executed multiple times on successive changes in a short interval.
An example: a script at the location `~/.syncthing-hooks/night-owlzz-5m` will be executed five minutes after the most recent event in the folder with the identifier `night-owlzz`.
Don't forget to `chmod +x` the script.