about summary refs log tree commit diff
README(7) Miscellaneous Information Manual README(7)

litterboxIRC logger

litterbox(1) is a TLS-only IRC logger. It logs events from IRC in a SQLite database, indexing messages for full-text search. It is intended for use with the IRC bouncer pounce, but can also be used independently as a logging bot.

litterbox provides the scoop(1) command-line query utility. A web interface for litterbox is provided by scooper. Some formats of plain text logs can be imported into the litterbox database with unscoop(1).

litterbox requires SQLite3 and libtls, provided by either LibreTLS (for OpenSSL) or by LibreSSL. It targets FreeBSD, OpenBSD and Linux.

make all
sudo make install

If installing libtls manually to /usr/local, for example, make sure /usr/local/lib appears in /etc/ld.so.conf or /etc/ld.so.conf.d/* and be sure to run ldconfig(8) once the library is installed. Set PKG_CONFIG_PATH for ./configure to find it.

PKG_CONFIG_PATH=/usr/local/lib/pkgconfig ./configure

On FreeBSD and OpenBSD the recommended way to run litterbox is with the process supervisor catsit.

database functions and schema
IRC logging
query building and output formatting
log file processing
getopt_long(3)-integrated configuration parsing
XDG base directories

The upstream URL of this project is ⟨https://git.causal.agency/litterbox⟩. Contributions in any form can be sent to <list+litterbox@causal.agency>. For sending patches by email, see ⟨https://git-send-email.io⟩.

Monetary contributions can be donated via Liberapay.

litterbox(1), scoop(1), unscoop(1)

May 18, 2021 Causal Agency
(2)June McEnroe 2020-08-27Sandbox calico with pledge(2) and unveil(2)June McEnroe 2020-08-27Add support for OpenBSDJune McEnroe 2020-08-27Remove rc scriptsJune McEnroe 2020-08-27contrib/palaver: Fix documented database pathJune McEnroe 2020-08-27contrib/palaver: Remove rc scriptJune McEnroe 2020-08-27contrib/palaver: Fix database search and creationJune McEnroe 2020-08-27contrib/palaver: Use pounce's XDG directoryJune McEnroe 2020-08-27contrib/palaver: Only allow HTTPSJune McEnroe 2020-08-25Support the pounce_env rc variableJune McEnroe 2020-08-25Remove deprecated option namesJune McEnroe 2020-08-25Document configuration and data file searchJune McEnroe 2020-08-24Use dataOpen for save fileJune McEnroe 2020-08-24Use configOpen to load localCAJune McEnroe 2020-08-24Use configPath to load client cert/privJune McEnroe 2020-08-24Use configOpen in getopt_configJune McEnroe 2020-08-24Import xdg.c from catgirlJune McEnroe 2020-08-23Replace “RAND_bytes” by “getentropy”Issam E. Maghni 2020-08-16contrib/palaver: Add no message preview flagsJune McEnroe 2020-08-13contrib/palaver: Don't set channel for PMsJune McEnroe 2020-08-13Fix unintended interception of NICK after registrationJune McEnroe 2020-08-12Add Additional Components section to READMEJune McEnroe 2020-08-12Document -L / palaver optionJune McEnroe 2020-08-11contrib/palaver: Document service configurationJune McEnroe 2020-08-11contrib/palaver: Add install target and rc scriptJune McEnroe 2020-08-11contrib/palaver: Implement command and notificationsJune McEnroe