Add Sonarr Cloudron app package
- Add CloudronManifest.json with app configuration - Add Dockerfile for building Sonarr v4 image - Add start.sh script to launch Sonarr - Add icon.png for app icon - Update README.md with installation and usage instructions
This commit is contained in:
63
README.md
63
README.md
@@ -1,3 +1,64 @@
|
||||
# cloudron-sonarr
|
||||
|
||||
Smart PVR for newsgroup and bittorrent users. Packaged for Cloudron.
|
||||
Smart PVR for newsgroup and bittorrent users. Packaged for Cloudron.
|
||||
|
||||
## Description
|
||||
|
||||
Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
|
||||
|
||||
## Installation
|
||||
|
||||
### Prerequisites
|
||||
|
||||
You need to install Cloudron CLI: [here](https://docs.cloudron.io/packaging/cli/).
|
||||
After you need to connect the CLI to your cloudron instance.
|
||||
|
||||
### Install app
|
||||
|
||||
To install this app, you need to be in the app's folder, then:
|
||||
|
||||
```bash
|
||||
cloudron install --image [DOCKER IMAGE NAME]
|
||||
```
|
||||
|
||||
You need to be in the folder of the app before running the command because cloudron CLI needs to read `CloudronManifest.json` file.
|
||||
|
||||
### Building the Docker Image
|
||||
|
||||
To build the Docker image:
|
||||
|
||||
```bash
|
||||
docker build -t your-dockerhub-username/cloudron-sonarr:1.0.0 .
|
||||
```
|
||||
|
||||
Then push to Docker Hub:
|
||||
|
||||
```bash
|
||||
docker push your-dockerhub-username/cloudron-sonarr:1.0.0
|
||||
```
|
||||
|
||||
### Cloudron Volumes
|
||||
|
||||
You may want to create volumes for:
|
||||
- Download folder (for completed downloads)
|
||||
- Media library (for your TV shows)
|
||||
|
||||
Here is the guide to create cloudron volume: [guide](https://docs.cloudron.io/volumes/#add).
|
||||
|
||||
**I recommend to choose "Filesystem" mount type when you create the volumes.**
|
||||
|
||||
**⚠️ You need to physically create the folder on host before, cloudron can't create one for you.**
|
||||
|
||||
To connect a volume to the app, go to app's settings, then "storage" tab and "mount" options on right panel.
|
||||
|
||||
## Configuration
|
||||
|
||||
Sonarr will store its configuration in `/app/data/config/` which is automatically managed by Cloudron's localstorage addon.
|
||||
|
||||
## Access
|
||||
|
||||
After installation, Sonarr will be available at the URL provided by Cloudron. The default port is 8989.
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see LICENSE file for details.
|
||||
|
||||
Reference in New Issue
Block a user