Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pteich/fofiwano
💡 Watcher for folder and file modifications that sends Slack notifications, HTTP requests or execute programs
https://github.com/pteich/fofiwano
filesystem go incron notifications slack watcher
Last synced: about 3 hours ago
JSON representation
💡 Watcher for folder and file modifications that sends Slack notifications, HTTP requests or execute programs
- Host: GitHub
- URL: https://github.com/pteich/fofiwano
- Owner: pteich
- License: mit
- Created: 2016-11-27T09:12:14.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-02-17T20:18:18.000Z (almost 6 years ago)
- Last Synced: 2024-06-20T15:47:26.596Z (7 months ago)
- Topics: filesystem, go, incron, notifications, slack, watcher
- Language: Go
- Homepage:
- Size: 24.4 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Watcher and Notifications for File and Folder changes
A small CLI tool that watches folders or files for modifications like added, changed or deleted files. It then sends a notification to a specific endpoint, e.g. a Slack channel, an URL (HTTP request) or execute a command.
It makes use of the [github.com/rjeczalik/notify Go library](https://github.com/rjeczalik/notify) to provide cross-platform filesystem notifications.
Fofiwano is available as pre-built binaries for macOS, Linux, FreeBSD and Windows on the [release page](https://github.com/pteich/fofiwano/releases).
Create a config file `.fofiwano.yml` in the current directory or in your `$HOME` with content like this (see [example](.fofiwano.example.yml)):
```yaml
watching:
# recursive watching ./test
- target: ./test/...
notifications:
- notify: slack
event: all
options:
channel: "#test"
username: "fofiwano"
webhook_url: "https://hooks.slack.com/services/..."
icon_emoji: ":monkey_face:"
footer: "fofiwano"
- notify: http
event: write
options:
URL: http://my.endpoint.com
# only watching ./test2 and NO sub-folders
- target: ./test2
notifications:
- notify: http
event: write
options:
URL: http://test.com
```
- `target` can be a single file or a folder. Add `/...` to a folder to create a recursive watcher that also reacts to modifications in sub-folders.`
- `notifications` is an array of notification providers with their options. *Right now only Slack and HTTP (GET) notifications are available!* (more to come).
- `event` can be one of `all`, `write`, `create`, `remove` or `rename`
*Hint:* You don't have to stick with YAML if you don't like it. You can write your config in every format that [Viper](https://github.com/spf13/viper) supports (JSON, TOML, YAML, HCL, and Java properties config files).
Start your watcher like so:
```bash
fofiwano watch
```
You can also provide the path to your config file with the `--config` flag:
```bash
fofiwano --config ~/.fofiwano.yml watch
```
Get help about all available flags and commands:
```bash
fofiwano --help
```
## Slack Notification
Available options:
```yaml
channel: "#test"
username: "fofiwano"
webhook_url: "https://hooks.slack.com/services/..."
icon_emoji: ":monkey_face:"
footer: "fofiwano"
```
## HTTP Notification
Available options:
```yaml
URL: "http://my.endpoint.com"
method: "GET" # GET or POST
param_event: "event" # parameter name for event
param_path: "param" # parameter name for path
```
GET and POST is supported.
For GET the given URL will be called with the following paramter names:
`http://my.endpoint.com?event=notify.rename&path=/home/myname/files/test.txt`
For POST endpoints a JSON with the following content is sent as body:
````json
{
"event": "notify.rename",
"path": "/home/myname/files/test.txt"
}
````
## TODO:
- add more notification providers (command execution)
- add templates for fine grained control over notification messages
- add queue for notification events to prevent locks
- add tests
## Similar tools
Tools with similar functionality:
- https://github.com/splitbrain/Watcher
- http://incron.aiken.cz/