docker-documentation/images/docker-couchpotato.md

155 wiersze
6.2 KiB
Markdown
Czysty Zwykły widok Historia

2019-10-04 08:44:24 +00:00
# [linuxserver/couchpotato](https://github.com/linuxserver/docker-couchpotato)
2019-02-08 09:44:22 +00:00
2019-10-04 08:44:24 +00:00
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-couchpotato.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-couchpotato/releases)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/couchpotato.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/couchpotato "Get your own version badge on microbadger.com")
[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/couchpotato.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/couchpotato "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/couchpotato.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/couchpotato)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/couchpotato.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/couchpotato)
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-couchpotato/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-couchpotato/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/couchpotato/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/couchpotato/latest/index.html)
2019-02-08 09:44:22 +00:00
[Couchpotato](https://couchpota.to/) is an automatic NZB and torrent downloader. You can keep a `movies I want` list and it will search for NZBs/torrents of these movies every X hours. Once a movie is found, it will send it to SABnzbd or download the torrent to a specified directory.
## Supported Architectures
2019-09-06 08:43:59 +00:00
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/).
2019-02-08 09:44:22 +00:00
2019-02-15 09:43:40 +00:00
Simply pulling `linuxserver/couchpotato` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-08 09:44:22 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2019-10-04 08:44:24 +00:00
| :----: | --- |
2019-02-08 09:44:22 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 20:31:26 +00:00
| armhf | arm32v7-latest |
2019-02-08 09:44:22 +00:00
2019-10-04 08:44:24 +00:00
2019-02-08 09:44:22 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-10-04 08:44:24 +00:00
```
2019-02-08 09:44:22 +00:00
docker create \
--name=couchpotato \
2019-03-08 09:43:46 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-08 09:44:22 +00:00
-e TZ=Europe/London \
-e UMASK_SET=022 \
-p 5050:5050 \
-v </path/to/appdata/config>:/config \
-v </path/to/downloads>:/downloads \
-v </path/to/movies>:/movies \
--restart unless-stopped \
linuxserver/couchpotato
```
2019-10-04 08:44:24 +00:00
2019-02-08 09:44:22 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
couchpotato:
image: linuxserver/couchpotato
container_name: couchpotato
environment:
2019-03-08 09:43:46 +00:00
- PUID=1000
- PGID=1000
2019-02-08 09:44:22 +00:00
- TZ=Europe/London
- UMASK_SET=022
volumes:
- </path/to/appdata/config>:/config
- </path/to/downloads>:/downloads
- </path/to/movies>:/movies
ports:
- 5050:5050
restart: unless-stopped
```
## Parameters
2019-10-04 08:44:24 +00:00
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.
2019-02-08 09:44:22 +00:00
2019-10-04 08:44:24 +00:00
### Ports (`-p`)
2019-02-08 09:44:22 +00:00
| Parameter | Function |
2019-10-04 08:44:24 +00:00
| :----: | --- |
2019-02-08 09:44:22 +00:00
| `5050` | http gui |
2019-10-04 08:44:24 +00:00
### Environment Variables (`-e`)
2019-02-08 09:44:22 +00:00
| Env | Function |
2019-10-04 08:44:24 +00:00
| :----: | --- |
2019-03-08 09:43:46 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-08 09:44:22 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
| `UMASK_SET=022` | for umask setting of couchpotato, optional , default if left unset is 022 |
2019-10-04 08:44:24 +00:00
### Volume Mappings (`-v`)
2019-02-08 09:44:22 +00:00
| Volume | Function |
2019-10-04 08:44:24 +00:00
| :----: | --- |
2019-02-08 09:44:22 +00:00
| `/config` | Couchpotato Application Data. |
| `/downloads` | Downloads Folder. |
| `/movies` | Movie Share. |
2019-10-04 08:44:24 +00:00
2019-02-08 09:44:22 +00:00
## User / Group Identifiers
2019-10-04 08:44:24 +00:00
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`.
2019-02-08 09:44:22 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-08 09:43:46 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2019-02-08 09:44:22 +00:00
2019-10-04 08:44:24 +00:00
```
2019-02-08 09:44:22 +00:00
$ id username
2019-03-08 09:43:46 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-08 09:44:22 +00:00
```
## Application Setup
Access the webui at `<your-ip>:5050`, for more information check out [CouchPotato](https://couchpota.to).
2019-10-04 08:44:24 +00:00
2019-02-08 09:44:22 +00:00
## Support Info
2019-09-06 08:43:59 +00:00
* Shell access whilst the container is running:
2019-02-08 09:44:22 +00:00
* `docker exec -it couchpotato /bin/bash`
2019-09-06 08:43:59 +00:00
* To monitor the logs of the container in realtime:
2019-02-08 09:44:22 +00:00
* `docker logs -f couchpotato`
2019-09-06 08:43:59 +00:00
* Container version number
2019-02-08 09:44:22 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' couchpotato`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/couchpotato`
## Versions
2019-07-02 15:28:09 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-03-24 20:31:26 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-24 04:48:49 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-08 09:44:22 +00:00
* **14.01.19:** - Multi-arch builds.
* **16.08.18:** - Rebase to alpine 3.8.
* **06.11.17:** - Rebase to alpine 3.7.
2019-10-04 08:44:24 +00:00
* **20.07.17:** - Internal git pull instead of at runtime, add UMASK_SET variable.
2019-02-08 09:44:22 +00:00
* **12.07.17:** - Add inspect commands to README, move to jenkins build and push
* **25.05.17:** - Rebase to alpine 3.6
* **07.02.17:** - Rebase to alpine 3.5.
2019-10-04 08:44:24 +00:00
* **11.11.16:** - Stop cp logging to docker log (they are accessible in the webui and the config folder).
2019-02-08 09:44:22 +00:00
* **30.09.16:** - Fix umask.
* **09.09.16:** - Add layer badges to README.
* **27.08.16:** - Add badges to README.
* **08.08.16:** - Rebase to alpine linux.
* **12.11.15:** - Misc Code Cleanup.
* **02.10.15:** - Change to python baseimage.
2019-10-04 08:44:24 +00:00
* **28.07.15:** - Updated to latest baseimage (for testing), and a fix to autoupdate.