From c3687f6ce4db57d5b3a5dd9573f20a8493ec5bd7 Mon Sep 17 00:00:00 2001 From: TheSpad Date: Sun, 30 Jan 2022 14:26:40 +0000 Subject: [PATCH 1/2] New readme template --- README.md | 51 +++++++++++++++++++++++++-------------------------- 1 file changed, 25 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index d1d999e..03e331b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ - + [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io) @@ -37,7 +37,7 @@ Find us at: [![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/prowlarr) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/prowlarr.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/prowlarr) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/prowlarr.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/prowlarr) -[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-prowlarr%2Fjob%2Fdevelop%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-prowlarr/job/develop/) +[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-prowlarr%2Fjob%2Fnightly-alpine%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-prowlarr/job/nightly-alpine/) [![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fprowlarr%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/prowlarr/latest/index.html) [Prowlarr](https://github.com/Prowlarr/Prowlarr) is a indexer manager/proxy built on the popular arr .net/reactjs base stack to integrate with your various PVR apps. Prowlarr supports both Torrent Trackers and Usenet Indexers. It integrates seamlessly with Sonarr, Radarr, Lidarr, and Readarr offering complete management of your indexers with no per app Indexer setup required (we do it all). @@ -46,27 +46,28 @@ Find us at: ## Supported Architectures -Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). +We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). -Simply pulling `ghcr.io/linuxserver/prowlarr` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. +Simply pulling `lscr.io/linuxserver/prowlarr` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. The architectures supported by this image are: -| Architecture | Tag | -| :----: | --- | -| x86-64 | amd64-latest | -| arm64 | arm64v8-latest | -| armhf | arm32v7-latest | +| Architecture | Available | Tag | +| :----: | :----: | ---- | +| x86-64 | ✅ | amd64-latest | +| arm64 | ✅ | arm64v8-latest | +| armhf| ✅ | arm32v7-latest | ## Version Tags -This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them. +This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags. -| Tag | Description | -| :----: | --- | -| develop | Prowlarr releases from their develop branch | -| nightly | Prowlarr releases from their nightly branch | -| nightly-alpine | Prowlarr releases from their nightly branch using our Alpine baseimage | +| Tag | Available | Description | +| :----: | :----: |--- | +| latest | ❌ | | +| develop | ✅ | Prowlarr releases from their develop branch | +| nightly | ✅ | Prowlarr releases from their nightly branch | +| nightly-alpine | ✅ | Prowlarr releases from their nightly branch using our Alpine baseimage | ## Application Setup @@ -78,16 +79,14 @@ Setup info can be found [here](https://wikijs.servarr.com/prowlarr/quick-start-g Here are some example snippets to help you get started creating a container. -### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose)) - -Compatible with docker-compose v2 schemas. +### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) ```yaml --- version: "2.1" services: prowlarr: - image: ghcr.io/linuxserver/prowlarr:develop + image: lscr.io/linuxserver/prowlarr container_name: prowlarr environment: - PUID=1000 @@ -100,7 +99,7 @@ services: restart: unless-stopped ``` -### docker cli +### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/)) ```bash docker run -d \ @@ -111,7 +110,7 @@ docker run -d \ -p 9696:9696 \ -v /path/to/data:/config \ --restart unless-stopped \ - ghcr.io/linuxserver/prowlarr:develop + lscr.io/linuxserver/prowlarr ``` ## Parameters @@ -169,7 +168,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to * container version number * `docker inspect -f '{{ index .Config.Labels "build_version" }}' prowlarr` * image version number - * `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/prowlarr` + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/prowlarr` ## Updating Info @@ -187,7 +186,7 @@ Below are the instructions for updating containers: ### Via Docker Run -* Update the image: `docker pull ghcr.io/linuxserver/prowlarr` +* Update the image: `docker pull lscr.io/linuxserver/prowlarr` * Stop the running container: `docker stop prowlarr` * Delete the container: `docker rm prowlarr` * Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved) @@ -222,7 +221,7 @@ cd docker-prowlarr docker build \ --no-cache \ --pull \ - -t ghcr.io/linuxserver/prowlarr:latest . + -t lscr.io/linuxserver/prowlarr:latest . ``` The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static` @@ -235,5 +234,5 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64 ## Versions -* **28.12.21:** - Added nightly-alpine branch. -* **06.06.21:** - Initial release of `develop` and `nightly` tags. \ No newline at end of file +* **28.12.21:** - Add nightly-alpine branch. +* **06.06.21:** - Initial realease. From 8e5d232ccf6bfcd2352e7d8a0122c61db05db76f Mon Sep 17 00:00:00 2001 From: TheSpad Date: Sun, 30 Jan 2022 14:45:20 +0000 Subject: [PATCH 2/2] Fix release base, clarify arch tags --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 03e331b..4b72095 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ Find us at: [![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fprowlarr?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fprowlarr) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-prowlarr.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-prowlarr) -[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-prowlarr.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-prowlarr/releases) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-prowlarr.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github&include_prereleases)](https://github.com/linuxserver/docker-prowlarr/releases) [![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-prowlarr/packages) [![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-prowlarr/container_registry) [![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/prowlarr) @@ -54,9 +54,9 @@ The architectures supported by this image are: | Architecture | Available | Tag | | :----: | :----: | ---- | -| x86-64 | ✅ | amd64-latest | -| arm64 | ✅ | arm64v8-latest | -| armhf| ✅ | arm32v7-latest | +| x86-64 | ✅ | amd64-\ | +| arm64 | ✅ | arm64v8-\ | +| armhf| ✅ | arm32v7-\ | ## Version Tags