hq/syncthing-hooks
4
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

explanation for new env vars

Browse source
This commit is contained in:
bus 2021-04-30 00:58:21 +02:00
parent a32ca79e02
commit f96da3e2b4
1 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -22,6 +22,13 @@ 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://<ip>: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
@ -44,7 +51,9 @@ pm2 logs
## Hooks
Create a folder in your home directory called `.syncthing-hooks`. Each hook is a file with the following naming scheme:
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`