aboutsummaryrefslogtreecommitdiff
path: root/README.org
blob: a3aed5ce10ac948164967cb84c7025b44f2a32f8 (plain)
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
#+TITLE: catinator

catinator is an irc bot made by and for the ~#gnulag~ channel on snoonet. It also tries to be usable as a general purpose higher level IRC bot making library, based on the [[https://docs.rs/irc][irc crate]].

* Configuration
The main configuration file is [[file:config.toml][config.toml]] and gets loaded from the current
~$PWD~. The configuration file is using profiles, the ~default~ profile is
loaded as a base. If the binary is compiled in release mode the ~release~
profile is merged. You can override any variables from ~default~ profile in the
~release~ or ~debug~ profile. If the binary is compiled in debug mode the
~debug~ profile is loaded from [[file:config.debug.toml][config.debug.toml]].

All of the settings can also be set using environment variables. The options are
prefixed with ~CATINATOR_~, nested variables are sepperated by ~_~.

Common environment variables:
- ~CATINATOR_USER_PASSWORD~
- ~CATINATOR_WA_API_KEY~

* Developing & Running
#+begin_src shell
# Compile binary
$ cargo build

# Run catinator
$ cargo run

# Run tests
$ cargo test
#+end_src

** Logging
you can change the log level by setting the ~RUST_LOG~ environment variable.
Available levels are in decreasing verbosity: ~trace~, ~debug~, ~info~, ~warn~,
~error~
ines.git/commit/secrets?id=e7d81af57fe372e08b7d0193d31a9ff614d7a737&follow=1'>add homepage dashboardMax Audron-3/+284 2025-08-01disable not used gameserversMax Audron-1/+2 2025-08-01add minecraft prometheus exporterMax Audron-3/+67 2025-08-01more monitoring & scrape config shortcutsMax Audron-68/+63 2025-08-01update garage to 2.0Max Audron-6/+10 2025-07-31fix authentik-ldap port bindingsMax Audron-0/+5 2025-07-31update to nixos 25.05Max Audron-113/+65 2025-07-31add more monitoring exporters and scrapersMax Audron-17/+57 2025-07-30try to run authentik nativelyMax Audron-26/+303 2025-07-30more metricsMax Audron-1/+41 2025-07-30enable firewallsMax Audron-1/+39