diff --git a/README.md b/README.md index 57504b3..8ca7e21 100644 --- a/README.md +++ b/README.md @@ -64,8 +64,10 @@ services: ## Running manually 1) Clone the repository with `git clone https://github.com/Fxsch/decluttarr.git` -2) Tweak the `config.conf` file inside the config folder to your needs (this file is disregarded when running via docker-compose.yml) -3) Run the script with `python3 main.py` +2) Rename the `config.conf-Example` inside the config folder to `config.conf` +3) Tweak `config.conf` to your needs +4) Run the script with `python3 main.py` +Note: The `config.conf` is disregarded when running via docker-compose.yml ## Explanation of the settings **LOG_LEVEL** diff --git a/config/config.conf-Example b/config/config.conf-Example new file mode 100644 index 0000000..0942e11 --- /dev/null +++ b/config/config.conf-Example @@ -0,0 +1,30 @@ +[general] +LOG_LEVEL = VERBOSE +TEST_RUN = True + +[features] +REMOVE_TIMER = 10 +REMOVE_FAILED = True +REMOVE_STALLED = True +REMOVE_METADATA_MISSING = True +REMOVE_ORPHANS = True +REMOVE_UNMONITORED = True +PERMITTED_ATTEMPTS = 3 +NO_STALLED_REMOVAL_QBIT_TAG = Don't Kill If Stalled + +[radarr] +RADARR_URL = http://radarr:7878 +RADARR_KEY = $RADARR_API_KEY + +[sonarr] +SONARR_URL = http://sonarr:8989 +SONARR_KEY = $SONARR_API_KEY + +[lidarr] +LIDARR_URL = http://lidarr:8686 +LIDARR_KEY = $LIDARR_API_KEY + +[qbittorrent] +QBITTORRENT_URL = http://qbittorrent:8080 +QBITTORRENT_USERNAME = Your name (or empty) +QBITTORRENT_PASSWORD = Your password (or empty) \ No newline at end of file