diff --git a/images/docker-medusa.md b/images/docker-medusa.md index 960c0a9cd..70552b378 100644 --- a/images/docker-medusa.md +++ b/images/docker-medusa.md @@ -1,9 +1,16 @@ -# linuxserver/medusa +# [linuxserver/medusa](https://github.com/linuxserver/docker-medusa) -[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-medusa.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-medusa/releases) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/medusa.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/medusa) [![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/medusa.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/medusa) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/medusa.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/medusa) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/medusa.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/medusa) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-medusa/job/master/badge/icon?style=flat-square)](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) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-medusa.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-medusa/releases) +[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/medusa.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/medusa "Get your own version badge on microbadger.com") +[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/medusa.svg?style=flat-square&color=E68523)](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?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/medusa) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/medusa.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/medusa) +[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-medusa/job/master/badge/icon?style=flat-square)](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) [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. + ## 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) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). @@ -13,18 +20,19 @@ Simply pulling `linuxserver/medusa` should retrieve the correct image for your a The architectures supported by this image are: | Architecture | Tag | -| :---: | :--- | +| :----: | --- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v7-latest | + ## Usage Here are some example snippets to help you get started creating a container from this image. ### docker -```text +``` docker create \ --name=medusa \ -e PUID=1000 \ @@ -38,6 +46,7 @@ docker create \ linuxserver/medusa ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -64,39 +73,42 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `:` 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. +Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. -### Ports \(`-p`\) +### Ports (`-p`) | Parameter | Function | -| :---: | :--- | +| :----: | --- | | `8081` | The port for the Medusa webui | -### Environment Variables \(`-e`\) + +### Environment Variables (`-e`) | Env | Function | -| :---: | :--- | +| :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | | `TZ=Europe/London` | Specify a timezone to use e.g. Europe/London | -### Volume Mappings \(`-v`\) +### Volume Mappings (`-v`) | Volume | Function | -| :---: | :--- | +| :----: | --- | | `/config` | Cardigann config | | `/downloads` | Download location | | `/tv` | TV Shows location | + + ## 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`. +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=1000` and `PGID=1000`, to find yours use `id user` as below: -```text +``` $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` @@ -105,6 +117,8 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Web interface is at `:8081` , set paths for downloads, tv-shows to match docker mappings via the webui, for more information check out [Medusa](https://pymedusa.com/). + + ## Support Info * Shell access whilst the container is running: @@ -132,4 +146,3 @@ Web interface is at `:8081` , set paths for downloads, tv-shows to matc * **25.05.17:** - Rebase to alpine 3.6 * **07.02.17:** - Rebase to alpine 3.5 * **02.01.17:** - Initial Release -