Bot Updating Documentation

pull/45/head
LinuxServer-CI 2021-10-03 12:41:24 +02:00
rodzic 5b9ebf297f
commit 62452179b2
1 zmienionych plików z 10 dodań i 4 usunięć

Wyświetl plik

@ -10,6 +10,7 @@ title: 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 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) [![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)
[![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) [![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)
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/medusa)
[![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 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) [![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/) [![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/)
@ -21,7 +22,7 @@ title: medusa
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/). 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/).
Simply pulling `ghcr.io/linuxserver/medusa` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. Simply pulling `lscr.io/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: The architectures supported by this image are:
@ -48,7 +49,7 @@ To help you get started creating a container from this image you can either use
version: "2.1" version: "2.1"
services: services:
medusa: medusa:
image: ghcr.io/linuxserver/medusa image: lscr.io/linuxserver/medusa
container_name: medusa container_name: medusa
environment: environment:
- PUID=1000 - PUID=1000
@ -76,7 +77,7 @@ docker run -d \
-v <path to downloads>:/downloads \ -v <path to downloads>:/downloads \
-v <path to tv shows>:/tv \ -v <path to tv shows>:/tv \
--restart unless-stopped \ --restart unless-stopped \
ghcr.io/linuxserver/medusa lscr.io/linuxserver/medusa
``` ```
## Parameters ## Parameters
@ -105,6 +106,11 @@ Docker images are configured using parameters passed at runtime (such as those a
| `/downloads` | Download location | | `/downloads` | Download location |
| `/tv` | TV Shows location | | `/tv` | TV Shows location |
#### Miscellaneous Options
| Parameter | Function |
| :-----: | --- |
## Environment variables from files (Docker secrets) ## Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend `FILE__`. You can set any environment variable from a file by using a special prepend `FILE__`.
@ -150,7 +156,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
* Container version number * Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' medusa` * `docker inspect -f '{{ index .Config.Labels "build_version" }}' medusa`
* Image version number * Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/medusa` * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/medusa`
## Versions ## Versions