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-11 17:56:41 -05:00
rodzic 6bf903f1f8
commit a1dd9b43f0
1 zmienionych plików z 110 dodań i 61 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

171
images/docker-medusa.md
Wyświetl plik

@ -1,96 +1,145 @@
[linuxserverurl]: https://linuxserver.io # [linuxserver/medusa](https://github.com/linuxserver/docker-medusa)
[forumurl]: https://forum.linuxserver.io
[ircurl]: https://www.linuxserver.io/irc/
[podcasturl]: https://www.linuxserver.io/podcast/
[appurl]: https://github.com/pymedusa/Medusa
[hub]: https://hub.docker.com/r/linuxserver/medusa/
[![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/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)
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: [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.
* [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/medusa
[![](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 image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/medusa.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/medusa.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-medusa)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-medusa/)
[Medusa][appurl], 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. ## 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 |
[![medusa](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/medusa-readme.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=medusa \ --name=medusa \
-v <path to config>:/config \ -e PUID=1001 \
-v <path to downloads>:/downloads \ -e PGID=1001 \
-v <path to tv-shows>:/tv \ -e TZ=Europe/London \
-e PGID=<gid> -e PUID=<uid> \ -p 8081:8081 \
-e TZ=<timezone> \ -v <path to data>:/config \
-p 8081:8081 \ -v <path to downloads>:/downloads \
-v <path to tv shows>:/tv \
--restart unless-stopped \
linuxserver/medusa linuxserver/medusa
``` ```
### 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
```
## 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 |
| :----: | --- |
| `8081` | The port for the Medusa webui |
### Environment Variables (`-e`)
| 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 |
### Volume Mappings (`-v`)
| Volume | Function |
| :----: | --- |
| `/config` | Cardigann config |
| `/downloads` | Download location |
| `/tv` | TV Shows location |
* `-p 8081` - the port(s) ## User / Group Identifiers
* `-v /config` - where medusa should store config files.
* `-v /downloads` - your downloads folder
* `-v /tv` - your tv-shows folder
* `-e PGID` for GroupID - see below for explanation
* `-e PUID` for UserID - see below for explanation
* `-e TZ` for timezone information, eg Europe/London
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`.
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it medusa /bin/bash`. Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
### User / Group Identifiers In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
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" ™.
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
Web interface is at `<your ip>:8081` , set paths for downloads, tv-shows to match docker mappings via the webui. 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/).
## Info
* Shell access whilst the container is running: `docker exec -it medusa /bin/bash` ## Support Info
* To monitor the logs of the container in realtime: `docker logs -f medusa`
* container version number * Shell access whilst the container is running:
* `docker exec -it medusa /bin/bash`
`docker inspect -f '{{ index .Config.Labels "build_version" }}' medusa` * To monitor the logs of the container in realtime:
* `docker logs -f medusa`
* image version number * Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' medusa`
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/medusa` * Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/medusa`
## Versions ## Versions
+ **14.01.19:** Adding multi arch and pipeline logic. * **14.01.19:** - Adding multi arch and pipeline logic
+ **16.08.18:** Rebase to alpine 3.8. * **16.08.18:** - Rebase to alpine 3.8
+ **08.12.17:** Rebase to alpine 3.7. * **08.12.17:** - Rebase to alpine 3.7
+ **29.11.17:** Add py-gdbm for subtitles support. * **29.11.17:** - Add py-gdbm for subtitles support
+ **26.10.17:** Mediainfo moved from testing to community repo. * **26.10.17:** - Mediainfo moved from testing to community repo
+ **10.10.17:** Use repo version of mediainfo to shorten build time. * **10.10.17:** - Use repo version of mediainfo to shorten build time
+ **05.08.17:** Internal git pull instead of at runtime. * **05.08.17:** - Internal git pull instead of at runtime
+ **25.05.17:** Rebase to alpine 3.6. * **25.05.17:** - Rebase to alpine 3.6
+ **07.02.17:** Rebase to alpine 3.5. * **07.02.17:** - Rebase to alpine 3.5
+ **02.01.17:** Initial Release. * **02.01.17:** - Initial Release