Skip to content
This repository was archived by the owner on Feb 12, 2020. It is now read-only.

Commit c027a40

Browse files
j0nnymoej0nnymoe
authored
Merge pull request #12 from linuxserver/readme-vars
Readme vars
2 parents 16b1086 + ef40580 commit c027a40

File tree

2 files changed

+174
-150
lines changed

2 files changed

+174
-150
lines changed

‎README.md

Lines changed: 132 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,173 @@
1-
[linuxserverurl]: https://linuxserver.io
2-
[forumurl]: https://forum.linuxserver.io
3-
[ircurl]: https://www.linuxserver.io/irc/
4-
[podcasturl]: https://www.linuxserver.io/podcast/
5-
[appurl]: https://github.com/cardigann/cardigann
6-
[hub]: https://hub.docker.com/r/linuxserver/cardigann/
1+
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
72

8-
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
3+
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
94

10-
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
11-
* [forum.linuxserver.io][forumurl]
12-
* [IRC][ircurl] on freenode at `#linuxserver.io`
13-
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
5+
* regular and timely application updates
6+
* easy user mappings (PGID, PUID)
7+
* custom base image with s6 overlay
8+
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
9+
* regular security updates
1410

15-
# linuxserver/cardigann
16-
[![](https://images.microbadger.com/badges/version/linuxserver/cardigann.svg)](https://microbadger.com/images/linuxserver/cardigann "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/cardigann.svg)](https://microbadger.com/images/linuxserver/cardigann "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/cardigann.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/cardigann.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-cardigann)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-cardigann/)
11+
Find us at:
12+
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
13+
* [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
14+
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
15+
* [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
1716

18-
[Cardigann][appurl], a server for adding extra indexers to Sonarr, SickRage and CouchPotato via Torznab and TorrentPotato proxies. Behind the scenes Cardigann logs in and runs searches and then transforms the results into a compatible format.
17+
# PSA: Changes are happening
18+
19+
From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag.
20+
21+
TLDR: Multi-arch support is changing from multiple repos to one repo per container image.
22+
23+
# [linuxserver/cardigann](https://github.com/linuxserver/docker-cardigann)
24+
[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
25+
[![](https://images.microbadger.com/badges/version/linuxserver/cardigann.svg)](https://microbadger.com/images/linuxserver/cardigann "Get your own version badge on microbadger.com")
26+
[![](https://images.microbadger.com/badges/image/linuxserver/cardigann.svg)](https://microbadger.com/images/linuxserver/cardigann "Get your own version badge on microbadger.com")
27+
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/cardigann.svg)
28+
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/cardigann.svg)
29+
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-cardigann/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-cardigann/job/master/)
30+
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/cardigann/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/cardigann/latest/index.html)
31+
32+
[Cardigann](https://github.com/cardigann/cardigann) a server for adding extra indexers to Sonarr, SickRage and CouchPotato via Torznab and TorrentPotato proxies. Behind the scenes Cardigann logs in and runs searches and then transforms the results into a compatible format.
33+
34+
35+
[![cardigann](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/cardigann.png)](https://github.com/cardigann/cardigann)
36+
37+
## Supported Architectures
38+
39+
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).
40+
41+
Simply pulling `linuxserver/cardigann` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
42+
43+
The architectures supported by this image are:
44+
45+
| Architecture | Tag |
46+
| :----: | --- |
47+
| x86-64 | amd64-latest |
48+
| arm64 | arm64v8-latest |
49+
| armhf | arm32v6-latest |
1950

20-
[![cardigan](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/cardigan.png)][appurl]
2151

2252
## Usage
2353

54+
Here are some example snippets to help you get started creating a container.
55+
56+
### docker
57+
2458
```
2559
docker create \
2660
--name=cardigann \
27-
-v <path to data>:/config \
28-
-e PGID=<gid> -e PUID=<uid> \
61+
-e PUID=1001 \
62+
-e PGID=1001 \
63+
-e SOCKS_PROXY=IP:PORT \
64+
-e HTTP_PROXY=IP:PORT \
2965
-p 5060:5060 \
66+
-v <path to data>:/config \
67+
--restart unless-stopped \
3068
linuxserver/cardigann
69+
```
70+
71+
72+
### docker-compose
3173

74+
Compatible with docker-compose v2 schemas.
75+
76+
```
77+
---
78+
version: "2"
79+
services:
80+
cardigann:
81+
image: linuxserver/cardigann
82+
container_name: cardigann
83+
environment:
84+
- PUID=1001
85+
- PGID=1001
86+
- SOCKS_PROXY=IP:PORT
87+
- HTTP_PROXY=IP:PORT
88+
volumes:
89+
- <path to data>:/config
90+
ports:
91+
- 5060:5060
92+
mem_limit: 4096m
93+
restart: unless-stopped
3294
```
3395

3496
## Parameters
3597

36-
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
37-
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
38-
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
39-
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
40-
98+
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.
4199

42-
* `-p 5060` - the port(s)
43-
* `-v /config` - Where cardigann should store it's config files
44-
* `-e PGID` for GroupID - see below for explanation
45-
* `-e PUID` for UserID - see below for explanation
46-
* `-e SOCKS_PROXY` - for using a socks proxy - *optional*
47-
* `-e HTTP_PROXY` - for using an HTTP proxy - *optional*
100+
| Parameter | Function |
101+
| :----: | --- |
102+
| `-p 5060` | The port for the Cardigann webinterface |
103+
| `-e PUID=1001` | for UserID - see below for explanation |
104+
| `-e PGID=1001` | for GroupID - see below for explanation |
105+
| `-e SOCKS_PROXY=IP:PORT` | for using a socks proxy (optional) |
106+
| `-e HTTP_PROXY=IP:PORT` | for using a HTTP proxy (optional) |
107+
| `-v /config` | Cardigann config |
48108

49-
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it cardigann /bin/bash`.
109+
## User / Group Identifiers
50110

51-
### User / Group Identifiers
111+
When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
52112

53-
Sometimes when using data volumes (`-v` flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user `PUID` and group `PGID`. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
113+
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
54114

55-
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
115+
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
56116

57117
```
58-
$ id <dockeruser>
118+
$ id username
59119
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
60120
```
61121

62-
## Setting up the application
63122

64-
Configure via the webui at `<your-ip>:5060`
123+
&nbsp;
124+
## Application Setup
125+
126+
Access the webui at `<your-ip>:5060`, for more information check out [Cardigann](https://github.com/cardigann/cardigann).
65127

66128
By adding a variable to the run command, `SOCKS_PROXY` or `HTTP_PROXY` cardigann can be used with a proxy, *eg* `-e SOCKS_PROXY=localhost:1080`
67129

68-
The folder /config/definitions can be used to add additional tracker definitions (for more info see [Additional definitions](https://github.com/cardigann/cardigann#definitions)
130+
The folder `/config/definitions` can be used to add additional tracker definitions (for more info see [Additional definitions](https://github.com/cardigann/cardigann#definitions) ).
131+
69132

70133

71-
## Info
134+
## Support Info
72135

73136
* Shell access whilst the container is running: `docker exec -it cardigann /bin/bash`
74137
* To monitor the logs of the container in realtime: `docker logs -f cardigann`
75-
76-
* container version number
77-
78-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' cardigann`
79-
138+
* container version number
139+
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' cardigann`
80140
* image version number
81-
82-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/cardigann`
141+
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/cardigann`
142+
143+
## Updating Info
144+
145+
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
146+
147+
Below are the instructions for updating containers:
148+
149+
### Via Docker Run/Create
150+
* Update the image: `docker pull linuxserver/cardigann`
151+
* Stop the running container: `docker stop cardigann`
152+
* Delete the container: `docker rm cardigann`
153+
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
154+
* Start the new container: `docker start cardigann`
155+
* You can also remove the old dangling images: `docker image prune`
156+
157+
### Via Docker Compose
158+
* Update the image: `docker-compose pull linuxserver/cardigann`
159+
* Let compose update containers as necessary: `docker-compose up -d`
160+
* You can also remove the old dangling images: `docker image prune`
83161

84162
## Versions
85163

86-
+ **14.01.19:** Add multi arch and pipeline logic.
87-
+ **22.08.18:** Rebase to alpine 3.8.
88-
+ **06.05.18:** Use buildstage in Dockerfile.
89-
+ **06.12.17:** Rebase to alpine 3.7.
90-
+ **12.08.17:** Add npm install to build stage.
91-
+ **25.05.17:** Rebase to alpine 3.6.
92-
+ **07.02.17:** Rebase to alpine 3.5.
93-
+ **03.11.16:** Compiled using [sstamoulis'](https://github.com/sstamoulis) method
94-
+ **01.11.16:** Initial Release.
164+
* **01.02.19:** - Multi arch images and pipeline build logic
165+
* **14.01.19:** - Add multi arch and pipeline logic
166+
* **22.08.18:** - Rebase to alpine 3.8
167+
* **06.05.18:** - Use buildstage in Dockerfile
168+
* **06.12.17:** - Rebase to alpine 3.7
169+
* **12.08.17:** - Add npm install to build stage
170+
* **25.05.17:** - Rebase to alpine 3.6
171+
* **07.02.17:** - Rebase to alpine 3.5
172+
* **03.11.16:** - Compiled using [sstamoulis'](https://github.com/sstamoulis) method
173+
* **01.11.16:** - Initial Release

‎readme-vars.yml

Lines changed: 42 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -1,101 +1,46 @@
1-
---
2-
3-
# project information
41
project_name: cardigann
5-
full_custom_readme: |
6-
{% raw -%}
7-
[linuxserverurl]: https://linuxserver.io
8-
[forumurl]: https://forum.linuxserver.io
9-
[ircurl]: https://www.linuxserver.io/irc/
10-
[podcasturl]: https://www.linuxserver.io/podcast/
11-
[appurl]: https://github.com/cardigann/cardigann
12-
[hub]: https://hub.docker.com/r/linuxserver/cardigann/
13-
14-
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
15-
16-
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
17-
* [forum.linuxserver.io][forumurl]
18-
* [IRC][ircurl] on freenode at `#linuxserver.io`
19-
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
20-
21-
# linuxserver/cardigann
22-
[![](https://images.microbadger.com/badges/version/linuxserver/cardigann.svg)](https://microbadger.com/images/linuxserver/cardigann "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/cardigann.svg)](https://microbadger.com/images/linuxserver/cardigann "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/cardigann.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/cardigann.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-cardigann)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-cardigann/)
23-
24-
[Cardigann][appurl], a server for adding extra indexers to Sonarr, SickRage and CouchPotato via Torznab and TorrentPotato proxies. Behind the scenes Cardigann logs in and runs searches and then transforms the results into a compatible format.
25-
26-
[![cardigan](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/cardigan.png)][appurl]
27-
28-
## Usage
29-
30-
```
31-
docker create \
32-
--name=cardigann \
33-
-v <path to data>:/config \
34-
-e PGID=<gid> -e PUID=<uid> \
35-
-p 5060:5060 \
36-
linuxserver/cardigann
37-
38-
```
39-
40-
## Parameters
41-
42-
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
43-
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
44-
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
45-
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
46-
47-
48-
* `-p 5060` - the port(s)
49-
* `-v /config` - Where cardigann should store it's config files
50-
* `-e PGID` for GroupID - see below for explanation
51-
* `-e PUID` for UserID - see below for explanation
52-
* `-e SOCKS_PROXY` - for using a socks proxy - *optional*
53-
* `-e HTTP_PROXY` - for using an HTTP proxy - *optional*
54-
55-
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it cardigann /bin/bash`.
56-
57-
### User / Group Identifiers
58-
59-
Sometimes when using data volumes (`-v` flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user `PUID` and group `PGID`. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
60-
61-
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
62-
63-
```
64-
$ id <dockeruser>
65-
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
66-
```
67-
68-
## Setting up the application
69-
70-
Configure via the webui at `<your-ip>:5060`
2+
project_url: "https://github.com/cardigann/cardigann"
3+
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/cardigann.png"
4+
project_blurb: |
5+
[{{ project_name|capitalize }}]({{ project_url }}) a server for adding extra indexers to Sonarr, SickRage and CouchPotato via Torznab and TorrentPotato proxies. Behind the scenes Cardigann logs in and runs searches and then transforms the results into a compatible format.
6+
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
7+
8+
# supported architectures
9+
available_architectures:
10+
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
11+
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
12+
- { arch: "{{ arch_armhf }}", tag: "arm32v6-latest"}
13+
14+
# container parameters
15+
param_container_name: "{{ project_name }}"
16+
param_usage_include_vols: true
17+
param_volumes:
18+
- { vol_path: "/config", vol_host_path: "<path to data>", desc: "Cardigann config" }
19+
param_usage_include_ports: true
20+
param_ports:
21+
- { external_port: "5060", internal_port: "5060", port_desc: "The port for the Cardigann webinterface" }
22+
param_usage_include_env: true
23+
param_env_vars:
24+
- { env_var: "SOCKS_PROXY", env_value: "IP:PORT", desc: "for using a socks proxy (optional)"}
25+
- { env_var: "HTTP_PROXY", env_value: "IP:PORT", desc: "for using a HTTP proxy (optional)"}
26+
27+
# application setup block
28+
app_setup_block_enabled: true
29+
app_setup_block: |
30+
Access the webui at `<your-ip>:5060`, for more information check out [{{ project_name|capitalize }}]({{ project_url }}).
7131
7232
By adding a variable to the run command, `SOCKS_PROXY` or `HTTP_PROXY` cardigann can be used with a proxy, *eg* `-e SOCKS_PROXY=localhost:1080`
7333
74-
The folder /config/definitions can be used to add additional tracker definitions (for more info see [Additional definitions](https://github.com/cardigann/cardigann#definitions)
75-
76-
77-
## Info
78-
79-
* Shell access whilst the container is running: `docker exec -it cardigann /bin/bash`
80-
* To monitor the logs of the container in realtime: `docker logs -f cardigann`
81-
82-
* container version number
83-
84-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' cardigann`
85-
86-
* image version number
87-
88-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/cardigann`
89-
90-
## Versions
91-
92-
+ **14.01.19:** Add multi arch and pipeline logic.
93-
+ **22.08.18:** Rebase to alpine 3.8.
94-
+ **06.05.18:** Use buildstage in Dockerfile.
95-
+ **06.12.17:** Rebase to alpine 3.7.
96-
+ **12.08.17:** Add npm install to build stage.
97-
+ **25.05.17:** Rebase to alpine 3.6.
98-
+ **07.02.17:** Rebase to alpine 3.5.
99-
+ **03.11.16:** Compiled using [sstamoulis'](https://github.com/sstamoulis) method
100-
+ **01.11.16:** Initial Release.
101-
{%- endraw %}
34+
The folder `/config/definitions` can be used to add additional tracker definitions (for more info see [Additional definitions](https://github.com/cardigann/cardigann#definitions) ).
35+
# changelog
36+
changelogs:
37+
- { date: "01.02.19:", desc: "Multi arch images and pipeline build logic" }
38+
- { date: "14.01.19:", desc: "Add multi arch and pipeline logic" }
39+
- { date: "22.08.18:", desc: "Rebase to alpine 3.8" }
40+
- { date: "06.05.18:", desc: "Use buildstage in Dockerfile" }
41+
- { date: "06.12.17:", desc: "Rebase to alpine 3.7" }
42+
- { date: "12.08.17:", desc: "Add npm install to build stage" }
43+
- { date: "25.05.17:", desc: "Rebase to alpine 3.6" }
44+
- { date: "07.02.17:", desc: "Rebase to alpine 3.5" }
45+
- { date: "03.11.16:", desc: "Compiled using [sstamoulis'](https://github.com/sstamoulis) method" }
46+
- { date: "01.11.16:", desc: "Initial Release" }

0 commit comments

Comments
 (0)