Skip to content

Commit

Permalink
Refinements to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ManiMatter committed Feb 17, 2024
1 parent a608d91 commit 0365122
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 66 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,24 +47,24 @@ services:
- PERMITTED_ATTEMPTS=3
- NO_STALLED_REMOVAL_QBIT_TAG=Don't Kill If Stalled
# Radarr
- RADARR_URL=http://localhost:7878
- RADARR_URL=http://radarr:7878
- RADARR_KEY=$RADARR_API_KEY
# Sonarr
- SONARR_URL=http://localhost:8989
- SONARR_URL=http://sonarr:8989
- SONARR_KEY=$SONARR_API_KEY
# Lidarr
- LIDARR_URL=http://localhost:8686
- LIDARR_URL=http://lidarr:8686
- LIDARR_KEY=$LIDARR_API_KEY
# qBittorrent
- QBITTORRENT_URL=http://localhost:8080
- QBITTORRENT_URL=http://qbittorrent:8080
#- QBITTORRENT_USERNAME=Your name
#- QBITTORRENT_PASSWORD=Your password
```
3) Run `docker-compose up -d` in the directory where the file is located to create the docker container

## Running manually
1) Clone the repository with `git clone https://github.com/Fxsch/decluttarr.git`
2) Tweak the `config.conf` file to your needs
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`

## Explanation of the settings
Expand All @@ -86,7 +86,6 @@ services:

### **Features settings**
- Steers which type of cleaning is applied to the downloads queue
- Requires `QUEUE_CLEANING` to be set to `True` to take effect

**REMOVE_TIMER**
- Sets the frequency of how often the queue is checked for orphan and stalled downloads
Expand Down
30 changes: 0 additions & 30 deletions config.conf

This file was deleted.

30 changes: 0 additions & 30 deletions config/config.conf-Example

This file was deleted.

0 comments on commit 0365122

Please sign in to comment.