Skip to content

Latest commit

 

History

History
69 lines (57 loc) · 3.27 KB

README.md

File metadata and controls

69 lines (57 loc) · 3.27 KB
Raw

Librarian

A Discord bot for managing bookmarks.

GitHub Workflow Status GitHub Issues MIT License

About

Librarian is a Discord bot which allows users to bookmark messages and view them later. It is designed to be used in the Brackeys Discord server, but is open source and can be used in other servers.

Installing and configuring Librarian

Librarian runs in a Docker container, and there is a docker-compose.yml file which simplifies this process.

Clone the repository

To start off, clone the repository into your desired directory:

git clone https://github.com/BrackeysBot/Librarian.git

Step into the Librarian directory using cd Librarian, and continue with the steps below.

Setting things up

The bot's token is passed to the container using the DISCORD_TOKEN environment variable. Create a file named .env, and add the following line:

DISCORD_TOKEN=your_token_here

One directory is required to exist for Docker compose to mount as a container volume, so create the logs directory:

mkdir logs

The logs directory is used to store logs in a format similar to that of a Minecraft server. latest.log will contain the log for the current day and current execution. All past logs are archived.

This bot does not require any configuration, nor does it persist any data. This means that you can simply run the bot, and as long as a logs folder is mounted, it will work out of the box.

Launch Librarian

To launch Librarian, simply run the following commands:

sudo docker-compose build
sudo docker-compose up --detach

Updating Librarian

To update Librarian, simply pull the latest changes from the repo and restart the container:

git pull
sudo docker-compose stop
sudo docker-compose build
sudo docker-compose up --detach

Using Librarian

To bookmark a message, simply react to it with the bookmark emoji (🔖) or Apps > Bookmark Message. Bookmarks are sent as a DM to the user who bookmarked the message.

License

This bot is under the MIT License.

Disclaimer

This bot is tailored for use within the Brackeys Discord server. While this bot is open source, and you are free to use it in your own servers, you accept responsibility for any mishaps which may arise from the use of this software. Use at your own risk.