mirror
/
docker-documentation
kopia lustrzana https://github.com/linuxserver/docker-documentation
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Bot Updating Templated Files

pull/1/head
LinuxServer-CI 2019-02-12 14:28:51 +00:00
rodzic 24ce592fe0
commit 1830c25ff8
1 zmienionych plików z 106 dodań i 54 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

160
images/docker-cardigann.md
Wyświetl plik

@ -1,94 +1,146 @@
[linuxserverurl]: https://linuxserver.io # [linuxserver/cardigann](https://github.com/linuxserver/docker-cardigann)
[forumurl]: https://forum.linuxserver.io
[ircurl]: https://www.linuxserver.io/irc/
[podcasturl]: https://www.linuxserver.io/podcast/
[appurl]: https://github.com/cardigann/cardigann
[hub]: https://hub.docker.com/r/linuxserver/cardigann/
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] [![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
[![](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 version badge on microbadger.com")
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/cardigann.svg)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/cardigann.svg)
[![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/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/cardigann/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/cardigann/latest/index.html)
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: [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.
* [forum.linuxserver.io][forumurl]
* [IRC][ircurl] on freenode at `#linuxserver.io`
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
# linuxserver/cardigann
[![](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/)
[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. ## 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).
Simply pulling `linuxserver/cardigann` 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 | arm32v6-latest |
[![cardigan](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/cardigan.png)][appurl]
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
``` ```
docker create \ docker create \
--name=cardigann \ --name=cardigann \
-v <path to data>:/config \ -e PUID=1001 \
-e PGID=<gid> -e PUID=<uid> \ -e PGID=1001 \
-e SOCKS_PROXY=IP:PORT \
-e HTTP_PROXY=IP:PORT \
-p 5060:5060 \ -p 5060:5060 \
-v <path to data>:/config \
--restart unless-stopped \
linuxserver/cardigann linuxserver/cardigann
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
cardigann:
image: linuxserver/cardigann
container_name: cardigann
environment:
- PUID=1001
- PGID=1001
- SOCKS_PROXY=IP:PORT
- HTTP_PROXY=IP:PORT
volumes:
- <path to data>:/config
ports:
- 5060:5060
mem_limit: 4096m
restart: unless-stopped
``` ```
## Parameters ## Parameters
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. Docker 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.
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 ### Ports (`-p`)
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
| Parameter | Function |
| :----: | --- |
| `5060` | The port for the Cardigann webinterface |
* `-p 5060` - the port(s) ### Environment Variables (`-e`)
* `-v /config` - Where cardigann should store it's config files
* `-e PGID` for GroupID - see below for explanation
* `-e PUID` for UserID - see below for explanation
* `-e SOCKS_PROXY` - for using a socks proxy - *optional*
* `-e HTTP_PROXY` - for using an HTTP proxy - *optional*
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it cardigann /bin/bash`. | Env | Function |
| :----: | --- |
| `PUID=1001` | for UserID - see below for explanation |
| `PGID=1001` | for GroupID - see below for explanation |
| `SOCKS_PROXY=IP:PORT` | for using a socks proxy (optional) |
| `HTTP_PROXY=IP:PORT` | for using a HTTP proxy (optional) |
### User / Group Identifiers ### Volume Mappings (`-v`)
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" ™. | Volume | Function |
| :----: | --- |
| `/config` | Cardigann config |
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
## User / Group Identifiers
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`.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
``` ```
$ id <dockeruser> $ id username
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
``` ```
## Setting up the application ## Application Setup
Configure via the webui at `<your-ip>:5060` Access the webui at `<your-ip>:5060`, for more information check out [Cardigann](https://github.com/cardigann/cardigann).
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` 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`
The folder /config/definitions can be used to add additional tracker definitions (for more info see [Additional definitions](https://github.com/cardigann/cardigann#definitions) The folder `/config/definitions` can be used to add additional tracker definitions (for more info see [Additional definitions](https://github.com/cardigann/cardigann#definitions) ).
## Info
* Shell access whilst the container is running: `docker exec -it cardigann /bin/bash` ## Support Info
* To monitor the logs of the container in realtime: `docker logs -f cardigann`
* container version number * Shell access whilst the container is running:
* `docker exec -it cardigann /bin/bash`
`docker inspect -f '{{ index .Config.Labels "build_version" }}' cardigann` * To monitor the logs of the container in realtime:
* `docker logs -f cardigann`
* image version number * Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' cardigann`
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/cardigann` * Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/cardigann`
## Versions ## Versions
+ **14.01.19:** Add multi arch and pipeline logic. * **01.02.19:** - Multi arch images and pipeline build logic
+ **22.08.18:** Rebase to alpine 3.8. * **14.01.19:** - Add multi arch and pipeline logic
+ **06.05.18:** Use buildstage in Dockerfile. * **22.08.18:** - Rebase to alpine 3.8
+ **06.12.17:** Rebase to alpine 3.7. * **06.05.18:** - Use buildstage in Dockerfile
+ **12.08.17:** Add npm install to build stage. * **06.12.17:** - Rebase to alpine 3.7
+ **25.05.17:** Rebase to alpine 3.6. * **12.08.17:** - Add npm install to build stage
+ **07.02.17:** Rebase to alpine 3.5. * **25.05.17:** - Rebase to alpine 3.6
+ **03.11.16:** Compiled using [sstamoulis'](https://github.com/sstamoulis) method * **07.02.17:** - Rebase to alpine 3.5
+ **01.11.16:** Initial Release. * **03.11.16:** - Compiled using [sstamoulis'](https://github.com/sstamoulis) method
* **01.11.16:** - Initial Release