Merge pull request #79 from gauravpandeydotdev/readme-house-keeping
Readme House Keeping
This commit is contained in:
commit
0ea5e0f90c
1 changed files with 19 additions and 12 deletions
|
@ -1,20 +1,24 @@
|
||||||
# Requirements
|
# Requirements
|
||||||
|
|
||||||
Container: https://docs.linuxserver.io/images/docker-lidarr<br>
|
Container: https://docs.linuxserver.io/images/docker-lidarr<br>
|
||||||
|
|
||||||
# Installation/setup
|
# Installation/setup
|
||||||
|
|
||||||
1. Add 2 volumes to your container <br>
|
1. Add 2 volumes to your container <br>
|
||||||
`/custom-services.d` and `/custom-cont-init.d` (do not map to the same local folder...) <br>
|
`/custom-services.d` and `/custom-cont-init.d` (do not map to the same local folder...) <br>
|
||||||
Docker Run Example: <br>
|
Docker Run Example: <br>
|
||||||
`-v /path/to/preferred/local/folder-01:/custom-services.d` <br>
|
`-v /path/to/preferred/local/folder-01:/custom-services.d` <br>
|
||||||
`-v /path/to/preferred/local/folder-02:/custom-cont-init.d`
|
`-v /path/to/preferred/local/folder-02:/custom-cont-init.d`
|
||||||
3. Download the [script_init.bash](https://github.com/RandomNinjaAtk/arr-scripts/blob/main/lidarr/scripts_init.bash) and place it into the following folder: <br>
|
2. Download the [script_init.bash](https://github.com/RandomNinjaAtk/arr-scripts/blob/main/lidarr/scripts_init.bash) and place it into the following folder: <br>
|
||||||
`-v /path/to/preferred/local/folder-02:/custom-cont-init.d`
|
`-v /path/to/preferred/local/folder-02:/custom-cont-init.d`
|
||||||
4. Start your container and wait for the application to load
|
3. Start your container and wait for the application to load
|
||||||
5. Optional: Customize the configuration by modifying the following file `/config/extended.conf`
|
4. Optional: Customize the configuration by modifying the following file `/config/extended.conf`
|
||||||
6. Restart the container
|
5. Restart the container
|
||||||
|
|
||||||
# Updating
|
# Updating
|
||||||
|
|
||||||
Updating is a bit more combersum. To update, do the following:
|
Updating is a bit more combersum. To update, do the following:
|
||||||
|
|
||||||
1. Download/update your local `/config/extended.conf` file with the latest options from: [extended.conf](https://github.com/RandomNinjaAtk/arr-scripts/blob/main/lidarr/extended.conf)
|
1. Download/update your local `/config/extended.conf` file with the latest options from: [extended.conf](https://github.com/RandomNinjaAtk/arr-scripts/blob/main/lidarr/extended.conf)
|
||||||
2. Restart the container, wait for it to fully load the application.
|
2. Restart the container, wait for it to fully load the application.
|
||||||
3. Restart the container again, for the new scripts to activate.
|
3. Restart the container again, for the new scripts to activate.
|
||||||
|
@ -22,6 +26,7 @@ Updating is a bit more combersum. To update, do the following:
|
||||||
This configuration does its best to update everything automatically, but with how the core system is designed, the new scripts will not take affect until a second restart is completed because the container copies/uses the previous versions of the script for execution on the first restart.
|
This configuration does its best to update everything automatically, but with how the core system is designed, the new scripts will not take affect until a second restart is completed because the container copies/uses the previous versions of the script for execution on the first restart.
|
||||||
|
|
||||||
# Features
|
# Features
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
<tr>
|
<tr>
|
||||||
<td><img src="https://github.com/RandomNinjaAtk/docker-lidarr-extended/raw/main/.github/lidarr.png" width="150"></td>
|
<td><img src="https://github.com/RandomNinjaAtk/docker-lidarr-extended/raw/main/.github/lidarr.png" width="150"></td>
|
||||||
|
@ -70,16 +75,18 @@ This configuration does its best to update everything automatically, but with ho
|
||||||
* Queue Cleaner Script
|
* Queue Cleaner Script
|
||||||
* Automatically removes downloads that have a "warning" or "failed" status that will not auto-import into Lidarr, which enables Lidarr to automatically re-search for the album
|
* Automatically removes downloads that have a "warning" or "failed" status that will not auto-import into Lidarr, which enables Lidarr to automatically re-search for the album
|
||||||
|
|
||||||
For more details, visit the [Wiki](https://github.com/RandomNinjaAtk/arr-scripts/wiki)
|
For more details, visit the [Wiki](https://github.com/RandomNinjaAtk/arr-scripts/wiki/Lidarr)
|
||||||
|
|
||||||
### Audio & Video (Plex Example)
|
### Audio & Video (Plex Example)
|
||||||
|
|
||||||
![](https://github.com/RandomNinjaAtk/docker-lidarr-extended/raw/main/.github/plex.png)
|
![](https://github.com/RandomNinjaAtk/docker-lidarr-extended/raw/main/.github/plex.png)
|
||||||
|
|
||||||
### Video Example (Kodi)
|
### Video Example (Kodi)
|
||||||
|
|
||||||
![](https://github.com/RandomNinjaAtk/docker-lidarr-extended/raw/main/.github/kodi-music-videos.png)
|
![](https://github.com/RandomNinjaAtk/docker-lidarr-extended/raw/main/.github/kodi-music-videos.png)
|
||||||
|
|
||||||
|
|
||||||
# Credits
|
# Credits
|
||||||
|
|
||||||
- [LinuxServer.io Team](https://github.com/linuxserver/docker-lidarr)
|
- [LinuxServer.io Team](https://github.com/linuxserver/docker-lidarr)
|
||||||
- [Lidarr](https://lidarr.audio/)
|
- [Lidarr](https://lidarr.audio/)
|
||||||
- [Beets](https://beets.io/)
|
- [Beets](https://beets.io/)
|
||||||
|
|
Loading…
Reference in a new issue