aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 7c4f5ec81dcb50864743d2f6f67c1d9a7b843cb3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
# 🐈 `docker-litterbox`

[litterbox](https://git.causal.agency/litterbox/), the IRC logger, but Dockerised

## Usage

Running `docker-litterbox` requires that the `USER` environment variable be set.

A Docker volume must be set pointing to `/root/.config/litterbox` within the
container. The volume must contain a configuration file for `litterbox` named
`default`, along with all files referenced within said configuration file.

All file references must be proceeded by `/root/.config/litterbox`.