docker-documentation/images/docker-medusa.md

173 wiersze
8.5 KiB
Markdown
Czysty Zwykły widok Historia

2021-02-14 10:46:24 +00:00
---
title: medusa
---
2021-04-17 20:21:05 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-medusa/blob/master/.github/CONTRIBUTING.md -->
2020-07-01 23:48:54 +00:00
# [linuxserver/medusa](https://github.com/linuxserver/docker-medusa)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-medusa.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-medusa)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-medusa.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-medusa/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-medusa/packages)
2020-12-16 18:17:31 +00:00
[![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-medusa/container_registry)
2020-07-01 23:48:54 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/medusa.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/medusa)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/medusa.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/medusa)
[![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-medusa%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-medusa/job/master/)
2020-11-02 16:09:23 +00:00
[![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%2Fmedusa%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/medusa/latest/index.html)
2019-10-02 23:49:49 +00:00
2020-06-29 07:29:55 +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.
2020-04-29 23:49:06 +00:00
2019-02-11 22:56:41 +00:00
## Supported Architectures
2019-09-04 23:49:50 +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-11 22:56:41 +00:00
2020-11-02 16:09:23 +00:00
Simply pulling `ghcr.io/linuxserver/medusa` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-11 22:56:41 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2020-07-01 23:48:54 +00:00
| :----: | --- |
2019-02-11 22:56:41 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 21:04:11 +00:00
| armhf | arm32v7-latest |
2019-02-07 00:49:20 +00:00
2021-04-17 20:21:05 +00:00
## Application Setup
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/).
2020-07-01 23:48:54 +00:00
2019-02-07 00:49:20 +00:00
## Usage
2021-07-04 10:41:55 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2019-02-11 22:56:41 +00:00
2021-07-04 10:41:55 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2019-02-11 22:56:41 +00:00
```yaml
---
2020-04-08 23:49:21 +00:00
version: "2.1"
2019-02-11 22:56:41 +00:00
services:
medusa:
2020-11-02 16:09:23 +00:00
image: ghcr.io/linuxserver/medusa
2019-02-11 22:56:41 +00:00
container_name: medusa
environment:
2019-03-07 00:48:41 +00:00
- PUID=1000
- PGID=1000
2019-02-11 22:56:41 +00:00
- TZ=Europe/London
volumes:
- <path to data>:/config
- <path to downloads>:/downloads
- <path to tv shows>:/tv
ports:
- 8081:8081
restart: unless-stopped
```
2021-07-04 10:41:55 +00:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2020-10-07 23:49:47 +00:00
2021-04-17 20:21:05 +00:00
```bash
2020-10-07 23:49:47 +00:00
docker run -d \
--name=medusa \
-e PUID=1000 \
-e PGID=1000 \
-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 \
2020-11-02 16:09:23 +00:00
ghcr.io/linuxserver/medusa
2020-10-07 23:49:47 +00:00
```
2019-02-07 00:49:20 +00:00
## Parameters
2020-07-01 23:48:54 +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
2020-07-01 23:48:54 +00:00
### Ports (`-p`)
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
| Parameter | Function |
2020-07-01 23:48:54 +00:00
| :----: | --- |
2019-02-11 22:56:41 +00:00
| `8081` | The port for the Medusa webui |
2019-02-07 00:49:20 +00:00
2020-07-01 23:48:54 +00:00
### Environment Variables (`-e`)
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
| Env | Function |
2020-07-01 23:48:54 +00:00
| :----: | --- |
2019-03-07 00:48:41 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-11 22:56:41 +00:00
| `TZ=Europe/London` | Specify a timezone to use e.g. Europe/London |
2019-02-07 00:49:20 +00:00
2020-07-01 23:48:54 +00:00
### Volume Mappings (`-v`)
2019-02-07 00:49:20 +00:00
2019-02-11 22:56:41 +00:00
| Volume | Function |
2020-07-01 23:48:54 +00:00
| :----: | --- |
2020-09-26 01:23:58 +00:00
| `/config` | Medusa config |
2019-02-11 22:56:41 +00:00
| `/downloads` | Download location |
| `/tv` | TV Shows location |
2019-02-07 00:49:20 +00:00
2020-07-01 23:48:54 +00:00
## Environment variables from files (Docker secrets)
2020-06-03 23:49:13 +00:00
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
2021-04-17 20:21:05 +00:00
```bash
2020-06-03 23:49:13 +00:00
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
## Umask for running applications
2020-07-01 23:48:54 +00:00
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
2019-02-11 22:56:41 +00:00
## User / Group Identifiers
2020-07-01 23:48:54 +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-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-03-07 00:48:41 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2019-02-11 22:56:41 +00:00
2021-04-17 20:21:05 +00:00
```bash
2019-02-11 22:56:41 +00:00
$ id username
2019-03-07 00:48:41 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-11 22:56:41 +00:00
```
2019-02-07 00:49:20 +00:00
2020-04-08 23:49:21 +00:00
## Docker Mods
2021-04-17 20:21:05 +00:00
2020-10-07 23:49:47 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=medusa&query=%24.mods%5B%27medusa%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=medusa "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-08 23:49:21 +00:00
2020-10-07 23:49:47 +00:00
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
2020-04-08 23:49:21 +00:00
2019-02-11 22:56:41 +00:00
## Support Info
2019-02-07 00:49:20 +00:00
2019-09-04 23:49:50 +00:00
* Shell access whilst the container is running:
2019-02-11 22:56:41 +00:00
* `docker exec -it medusa /bin/bash`
2019-09-04 23:49:50 +00:00
* To monitor the logs of the container in realtime:
2019-02-11 22:56:41 +00:00
* `docker logs -f medusa`
2019-09-04 23:49:50 +00:00
* Container version number
2019-02-11 22:56:41 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' medusa`
* Image version number
2020-11-02 16:09:23 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/medusa`
2019-02-07 00:49:20 +00:00
## Versions
2020-06-08 16:24:43 +00:00
* **01.06.20:** - Rebasing to alpine 3.12.
2019-12-20 22:13:04 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-09-28 19:35:59 +00:00
* **22.09.19:** - Switch to python3.
2019-07-04 18:23:48 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-03-24 21:04:11 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-24 05:57:34 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
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