⛳ alerts for any ctfd instance via ntfy
docs: add readme
+75
+26
LICENSE.md
+26
LICENSE.md
···
1
+
The MIT License (MIT)
2
+
=====================
3
+
4
+
Copyright © `2025` `Kieran Klukas`
5
+
6
+
Permission is hereby granted, free of charge, to any person
7
+
obtaining a copy of this software and associated documentation
8
+
files (the “Software”), to deal in the Software without
9
+
restriction, including without limitation the rights to use,
10
+
copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+
copies of the Software, and to permit persons to whom the
12
+
Software is furnished to do so, subject to the following
13
+
conditions:
14
+
15
+
The above copyright notice and this permission notice shall be
16
+
included in all copies or substantial portions of the Software.
17
+
18
+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
19
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
20
+
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22
+
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23
+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24
+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25
+
OTHER DEALINGS IN THE SOFTWARE.
26
+
+49
README.md
+49
README.md
···
1
+
# ⛳ CTFd alerts
2
+
3
+
Sends alerts for any arbitrary [CTFd](https://ctfd.io/) instance via [ntfy](https://ntfy.sh/)
4
+
5
+
## Install
6
+
7
+
You can download a pre-built binary from the releases or you can use the following options
8
+
9
+
### Go
10
+
11
+
```bash
12
+
# Go
13
+
go install github.com/taciturnaxolotl/ctfd-alerts@latest
14
+
```
15
+
16
+
### Nix
17
+
18
+
```bash
19
+
# Direct installation with flakes enabled
20
+
nix profile install github:taciturnaxolotl/ctfd-alerts
21
+
```
22
+
23
+
For use in your own flake:
24
+
25
+
```nix
26
+
# In your flake.nix
27
+
{
28
+
inputs.akami.url = "github:taciturnaxolotl/ctfd-alerts";
29
+
30
+
outputs = { self, nixpkgs, akami, ... }: {
31
+
# Access the package as:
32
+
# ctfd-alerts.packages.${system}.default
33
+
};
34
+
}
35
+
```
36
+
37
+
Written in go. If you have any suggestions or issues feel free to open an issue on my [tangled](https://tangled.sh/@dunkirk.sh/ctfd-alerts) knot
38
+
39
+
<p align="center">
40
+
<img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/master/.github/images/line-break.svg" />
41
+
</p>
42
+
43
+
<p align="center">
44
+
<i><code>© 2025-present <a href="https://github.com/taciturnaxolotl">Kieran Klukas</a></code></i>
45
+
</p>
46
+
47
+
<p align="center">
48
+
<a href="https://github.com/taciturnaxolotl/ctfd-alerts/blob/master/LICENSE.md"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a>
49
+
</p>