commit 11f3a27013b57472c629017b42c55af21601e5fc · dunkirk.sh/ctfd-alerts

+26

LICENSE.md

···

       1
       1
       +
       The MIT License (MIT)

     

       2
       2
       +
       =====================

     

       3
       3
       +
       

     

       4
       4
       +
       Copyright © `2025` `Kieran Klukas`

     

       5
       5
       +
       

     

       6
       6
       +
       Permission is hereby granted, free of charge, to any person

     

       7
       7
       +
       obtaining a copy of this software and associated documentation

     

       8
       8
       +
       files (the “Software”), to deal in the Software without

     

       9
       9
       +
       restriction, including without limitation the rights to use,

     

       10
       10
       +
       copy, modify, merge, publish, distribute, sublicense, and/or sell

     

       11
       11
       +
       copies of the Software, and to permit persons to whom the

     

       12
       12
       +
       Software is furnished to do so, subject to the following

     

       13
       13
       +
       conditions:

     

       14
       14
       +
       

     

       15
       15
       +
       The above copyright notice and this permission notice shall be

     

       16
       16
       +
       included in all copies or substantial portions of the Software.

     

       17
       17
       +
       

     

       18
       18
       +
       THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,

     

       19
       19
       +
       EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

     

       20
       20
       +
       OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

     

       21
       21
       +
       NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

     

       22
       22
       +
       HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

     

       23
       23
       +
       WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

     

       24
       24
       +
       FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

     

       25
       25
       +
       OTHER DEALINGS IN THE SOFTWARE.

     

       26
       26
       +

+49

README.md

···

       1
       1
       +
       # ⛳ CTFd alerts

     

       2
       2
       +
       

     

       3
       3
       +
       Sends alerts for any arbitrary [CTFd](https://ctfd.io/) instance via [ntfy](https://ntfy.sh/)

     

       4
       4
       +
       

     

       5
       5
       +
       ## Install

     

       6
       6
       +
       

     

       7
       7
       +
       You can download a pre-built binary from the releases or you can use the following options

     

       8
       8
       +
       

     

       9
       9
       +
       ### Go

     

       10
       10
       +
       

     

       11
       11
       +
       ```bash

     

       12
       12
       +
       # Go

     

       13
       13
       +
       go install github.com/taciturnaxolotl/ctfd-alerts@latest

     

       14
       14
       +
       ```

     

       15
       15
       +
       

     

       16
       16
       +
       ### Nix

     

       17
       17
       +
       

     

       18
       18
       +
       ```bash

     

       19
       19
       +
       # Direct installation with flakes enabled

     

       20
       20
       +
       nix profile install github:taciturnaxolotl/ctfd-alerts

     

       21
       21
       +
       ```

     

       22
       22
       +
       

     

       23
       23
       +
       For use in your own flake:

     

       24
       24
       +
       

     

       25
       25
       +
       ```nix

     

       26
       26
       +
       # In your flake.nix

     

       27
       27
       +
       {

     

       28
       28
       +
         inputs.akami.url = "github:taciturnaxolotl/ctfd-alerts";

     

       29
       29
       +
       

     

       30
       30
       +
         outputs = { self, nixpkgs, akami, ... }: {

     

       31
       31
       +
           # Access the package as:

     

       32
       32
       +
           # ctfd-alerts.packages.${system}.default

     

       33
       33
       +
         };

     

       34
       34
       +
       }

     

       35
       35
       +
       ```

     

       36
       36
       +
       

     

       37
       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
       38
       +
       

     

       39
       39
       +
       <p align="center">

     

       40
       40
       +
       	<img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/master/.github/images/line-break.svg" />

     

       41
       41
       +
       </p>

     

       42
       42
       +
       

     

       43
       43
       +
       <p align="center">

     

       44
       44
       +
       	<i><code>&copy 2025-present <a href="https://github.com/taciturnaxolotl">Kieran Klukas</a></code></i>

     

       45
       45
       +
       </p>

     

       46
       46
       +
       

     

       47
       47
       +
       <p align="center">

     

       48
       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
       49
       +
       </p>