docker-documentation/images/docker-medusa.md

146 wiersze
5.1 KiB
Markdown
Czysty Zwykły widok Historia

2019-02-11 22:56:41 +00:00
# [linuxserver/medusa](https://github.com/linuxserver/docker-medusa)
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
[![](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/medusa.svg)](https://microbadger.com/images/linuxserver/medusa "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/medusa.svg)](https://microbadger.com/images/linuxserver/medusa "Get your own version badge on microbadger.com")
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/medusa.svg)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/medusa.svg)
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-medusa/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-medusa/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/medusa/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/medusa/latest/index.html)
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
[Medusa](https://pymedusa.com/) is an automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic.
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
## 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/medusa` 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 |
2019-02-07 00:49:20 +00:00
## Usage
2019-02-11 22:56:41 +00:00
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-02-07 00:49:20 +00:00
```
docker create \
--name=medusa \
2019-02-11 22:56:41 +00:00
-e PUID=1001 \
-e PGID=1001 \
-e TZ=Europe/London \
-p 8081:8081 \
-v <path to data>:/config \
-v <path to downloads>:/downloads \
-v <path to tv shows>:/tv \
--restart unless-stopped \
2019-02-07 00:49:20 +00:00
linuxserver/medusa
```
2019-02-11 22:56:41 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
medusa:
image: linuxserver/medusa
container_name: medusa
environment:
- PUID=1001
- PGID=1001
- TZ=Europe/London
volumes:
- <path to data>:/config
- <path to downloads>:/downloads
- <path to tv shows>:/tv
ports:
- 8081:8081
mem_limit: 4096m
restart: unless-stopped
```
2019-02-07 00:49:20 +00:00
## Parameters
2019-02-11 22:56:41 +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-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
### Ports (`-p`)
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
| Parameter | Function |
| :----: | --- |
| `8081` | The port for the Medusa webui |
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
### Environment Variables (`-e`)
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
| Env | Function |
| :----: | --- |
| `PUID=1001` | for UserID - see below for explanation |
| `PGID=1001` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use e.g. Europe/London |
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
### Volume Mappings (`-v`)
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
| Volume | Function |
| :----: | --- |
| `/config` | Cardigann config |
| `/downloads` | Download location |
| `/tv` | TV Shows location |
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
## 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`.
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +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-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
```
$ id username
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
```
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
## Application Setup
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
Web interface is at `<your ip>:8081` , set paths for downloads, tv-shows to match docker mappings via the webui, for more information check out [Medusa](https://pymedusa.com/).
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
## Support Info
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
* Shell access whilst the container is running:
* `docker exec -it medusa /bin/bash`
* To monitor the logs of the container in realtime:
* `docker logs -f medusa`
* Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' medusa`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/medusa`
2019-02-07 00:49:20 +00:00
## Versions
2019-02-11 22:56:41 +00:00
* **14.01.19:** - Adding multi arch and pipeline logic
* **16.08.18:** - Rebase to alpine 3.8
* **08.12.17:** - Rebase to alpine 3.7
* **29.11.17:** - Add py-gdbm for subtitles support
* **26.10.17:** - Mediainfo moved from testing to community repo
* **10.10.17:** - Use repo version of mediainfo to shorten build time
* **05.08.17:** - Internal git pull instead of at runtime
* **25.05.17:** - Rebase to alpine 3.6
* **07.02.17:** - Rebase to alpine 3.5
* **02.01.17:** - Initial Release