Update README.md

2 years ago · 3b8417e31b
parent 7ce3094139
commit 3b8417e31b
1 changed files with 80 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1 +1,80 @@
-# docker-radarr-extended
+# [RandomNinjaAtk/radarr-extended](https://github.com/RandomNinjaAtk/docker-radarr-extended)
+[![Docker Build](https://img.shields.io/docker/cloud/automated/randomninjaatk/radarr-extended?style=flat-square)](https://hub.docker.com/r/randomninjaatk/radarr-extended)
+[![Docker Pulls](https://img.shields.io/docker/pulls/randomninjaatk/radarr-extended?style=flat-square)](https://hub.docker.com/r/randomninjaatk/radarr-extended)
+[![Docker Stars](https://img.shields.io/docker/stars/randomninjaatk/radarr-extended?style=flat-square)](https://hub.docker.com/r/randomninjaatk/radarr-extended)
+[![Docker Hub](https://img.shields.io/badge/Open%20On-DockerHub-blue?style=flat-square)](https://hub.docker.com/r/randomninjaatk/radarr-extended)
+
+[Radarr](https://github.com/Radarr/Radarr) - A fork of Sonarr to work with movies à la Couchpotato.
+
+
+[![radarr](https://raw.githubusercontent.com/RandomNinjaAtk/unraid-templates/master/randomninjaatk/img/radarr.png)](https://github.com/Radarr/Radarr)
+
+This containers base image is provided by: [linuxserver/radarr](https://github.com/linuxserver/docker-radarr)
+
+
+## Supported Architectures
+
+The architectures supported by this image are:
+
+| Architecture | Available | Tag |
+| :----: | :----: | ---- |
+| multi | ✅ | latest |
+| x86-64 | ✅ | amd64 |
+| arm64v8 | ✅ | arm64v8 |
+| arm32v7 | ✅ | arm32v7 |
+
+## Version Tags
+
+| Tag | Description |
+| :----: | --- |
+| develop | Radarr (develop) + SMA + ffmpeg |
+
+## Parameters
+
+Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
+
+| Parameter | Function |
+| ---- | --- |
+| `-p 7878` | The port for the Radarr webinterface |
+| `-e PUID=1000` | for UserID - see below for explanation |
+| `-e PGID=1000` | for GroupID - see below for explanation |
+| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London, this is required for Radarr |
+| `-e UMASK_SET=022` | control permissions of files and directories created by Radarr |
+| `-v /config` | Database and Radarr configs |
+| `-v /storage` | Location of Movie Library and Download managers output directory |
+| `-e UPDATE_SMA="FALSE"` | TRUE = enabled :: Update SMA on container startup |
+
+## Application Setup
+
+Access the webui at `<your-ip>:7878`, for more information check out [Radarr](https://radarr.video/).
+
+# Radarr Configuration
+
+### Enable completed download handling
+* Settings -> Download Client -> Completed Download Handling -> Enable: Yes
+
+### Add Custom Script
+* Settings -> Connect -> + Add -> custom Script
+
+| Parameter | Value |
+| --- | --- |
+| On Grab | No |
+| On Import | Yes |
+| On Upgrade | Yes |
+| On Rename | No |
+| On Health Issue | No |
+| Tags | leave blank |
+| Path | `/scripts/postRadarr.sh` |
+
+# SMA Information:
+
+### Config Information
+Located at `/config/sma/autoProcess.ini` inside the container
+
+### Log Information
+Located at `/config/sma/sma.log` inside the container
+
+### Hardware Acceleration
+
+1. Set "video codec" to: `h264vaapi` or `h265vaapi` in "/config/sma/autoProcess.ini"
+1. Make sure you have passed the correct device to the container, or these will not work...