diff options
author | Parker <contact@pkrm.dev> | 2025-01-19 23:53:26 -0600 |
---|---|---|
committer | Parker <contact@pkrm.dev> | 2025-01-19 23:53:26 -0600 |
commit | dc86e686373b43760863d7a7766119bef87571dc (patch) | |
tree | 49f92dc5600da1c6e0cf47fb943b7fdce815986e /README.md | |
parent | b5bd2e36b6597303985eb9dc897e04d452950372 (diff) |
Add Docker image
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 15 |
1 files changed, 14 insertions, 1 deletions
@@ -25,7 +25,20 @@ CordArr is a self-hosted Discord bot that allows you to add new movies or shows to your Radarr/Sonarr libraries, and allow users to create temporary Jellyfin accounts on your server. -# Instructions +# Self-hosting + +## Docker +To run Guava in Docker, use the provided [docker-compose.yaml](docker-compose.yaml) file as a template for the container. Use the configuration section below to fill out the necessary information. + +## Bare metal +To run Guava on bare metal, follow the steps below. + +1. Install Python 3 and Pip +2. Clone this repository +3. Install the requirements with `pip install -r requirements.txt` +4. Run the `code/bot.py` file +5. Input information into the newly created config.yaml file. +6. Re-run the `code/bot.py` file. CordArr is built on Python and requires you to install all of the dependencies in the `requirements.txt` file. To do this, you can run the pip install command like `pip install -r requirements.txt` |