fisher 1.0.0

Webhooks catcher written in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

# Installing Fisher

If you want to use Fisher in a new machine you need to install it. Fisher is
written in Rust, and it's available as a single binary you can drop into your
path.

Unfortunately, no precompiled packages for any Linux distribution are available
yet. In the future they might become available.

## Precompiled binaries

Official precompiled binaries are available from
[files.pietroalbini.org](https://files.pietroalbini.org/releases/fisher). You
can download the latest version from it and extract the binary contained in it
in your `${PATH}` (usually `/usr/local/bin`). There are also GPG signatures
available if you want to check them.

## Install from source

If you want to build Fisher from source, you need to have the Rust 1.17 (or
greater) toolchain installed on the target machine. Keep in mind this might
take a while to complete.

The easiest way to build from source is to build the package uploaded in the
Rust's package registry, [crates.io](https://crates.io/crates/fisher):

```
$ cargo install fisher
```

Instead, if you want to compile directly from the source code you need to fetch
the code from the git repository, and then build it with Cargo.

```
$ git clone https://github.com/pietroalbini/fisher
$ cd fisher
$ cargo build --release
```

The binary will be available in `target/release/fisher`.

## Starting Fisher at boot time

If you want to start Fisher at boot, you should create a new systemd service
(if your distribution uses systemd as the init). Place the following file in
`/etc/systemd/system/fisher.service`:

```
[Unit]
Description=The Fisher webhooks catcher

[Service]
ExecStart=/usr/local/bin/fisher /srv/webhooks/config.toml
ExecReload=/bin/kill -USR1 $MAINPID

User=fisher
Group=fisher

PrivateTmp=yes

[Install]
WantedBy=multi-user.target
```

This service assumes your system is configured this way:

- The Fisher binary is located in `/usr/local/bin/fisher`
- The configuration file is located in `/srv/webhooks/config.toml`
- Fisher is executed by the `fisher` user

If those things don't match your server configuration, you must change them in
the service file. Then, you can manage Fisher like every other systemd service:

```
$ systemctl start fisher
$ systemctl stop fisher
$ systemctl restart fisher
$ systemctl reload fisher
$ systemctl status fisher
```