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~
c322d1a316b6b9&follow=1'>fix crash on message only containing whitespaceMax Audron-1/+4 2021-06-11Release version 1.2.01.2.0Max Audron-2/+2 2021-06-06make pet more compactR0flcopt3r/catinator-pet-commandMax Audron-5/+5 2021-06-05feat: adds pet command.R0flcopt3r-0/+90 2021-06-05feat: send actionR0flcopt3r-1/+9 2021-06-05release version 1.1.0Max Audron-2/+2 2021-06-05document proc macrosMax Audron-4/+97 2021-06-05add intensifyMax Audron-3/+27 2021-06-05add privmsg macroMax Audron-2/+40 2021-06-05fix jb remote urlsMax Audron-4/+4 2021-06-05remove egress gateway configMax Audron-10/+0 2021-06-05update tanka dependenciesMax Audron-8/+8 2021-06-05fix init container nameMax Audron-1/+1 2021-06-05fix tanka dependency pathMax Audron-8/+8 2021-06-05switch to https url for tanka util libMax Audron-2/+2 2021-06-05bump version to 1.0.2Max Audron-2/+2 2021-06-05add tanka ci configurationMax Audron-1/+1 2021-06-05ready tanka deploy for CIMax Audron-32/+69 2021-06-05remove tanka vendoringMax Audron-27651/+0 2021-05-26Release 1.0.1Max Audron-3/+3 2021-05-26fix log breaking once buffer fullMax Audron-2/+33 2021-05-16add deployment stuffMax Audron-6/+27786 2021-05-15add container buildMax Audron-2/+35