selfhosting.md

host your own installation

credentials and setup

requirements:

• python3 and git
• tmux if you want to run it unattended

1. create a Discord application and add a bot account to it.
2. add the bot to your server using a modified version of an OAuth2 authorization link from Bot Authorization Flow.
3. clone the repository:

   git clone https://github.com/TicClick/librarian

   create a modified version of config/config.example.yaml and fill in whatever data you need. to benefit from GitHub's extended API limits, query it using an API token (get one at Personal access tokens)
4. setup and run the bot:

   ./bin.sh setup
   tmux new -d -s librarian-bot "./bin.sh run --config /path/to/config"

maintenance

stop the bot:

tmux kill-session -t librarian

update to the last stable version (make sure to stop the bot beforehand):

git fetch && git checkout main
git pull origin main
git checkout $( git tag --list --sort=v:refname | tail -n 1 )

for anything else, use bin.sh from the source directory:

./bin.sh setup  # install all dependencies
./bin.sh run --config /path/to/config.yaml  # start the bot
./bin.sh clean  # remove virtual environment and Python bytecode cache
./bin.sh test  # run unit tests with pytest
./bin.sh test -x -k TestDiscordCommands  # stop on the first failure of a test suite
./bin.sh coverage  # generate coverage data
./bin.sh cov  # print coverage stats in terminal
./bin.sh hcov  # render and open a nice HTML with coverage stats
./bin.sh db --config /path/to/config upgrade head  # run available schema migrations

if anything goes wrong, make extensive use of a runtime log located at {runtime}/librarian.log