From 2660d6de15383ee4e832acef923d725ec6b542a2 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Thu, 8 Jul 2021 16:04:20 +0000 Subject: [PATCH] Bot Updating Documentation --- images/docker-minisatip.md | 43 +++++++++++++++++--------------------- 1 file changed, 19 insertions(+), 24 deletions(-) diff --git a/images/docker-minisatip.md b/images/docker-minisatip.md index 3a5353ab8..7256ac608 100644 --- a/images/docker-minisatip.md +++ b/images/docker-minisatip.md @@ -1,13 +1,15 @@ --- title: minisatip --- + + + # [linuxserver/minisatip](https://github.com/linuxserver/docker-minisatip) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-minisatip.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-minisatip) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-minisatip.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-minisatip/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-minisatip/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-minisatip/container_registry) -[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/minisatip.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://microbadger.com/images/linuxserver/minisatip "Get your own version badge on microbadger.com") [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/minisatip.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/minisatip) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/minisatip.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/minisatip) [![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-minisatip%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-minisatip/job/master/) @@ -29,14 +31,19 @@ The architectures supported by this image are: | arm64 | arm64v8-latest | | armhf | arm32v7-latest | +## Application Setup + +Best used in conjunction with [tvheadend](https://github.com/linuxserver/docker-tvheadend) + +There is no setup per se, other than adding your cards for passthrough. + +You can then use your cards as DVB inputs in apps such as tvheadend. ## Usage -Here are some example snippets to help you get started creating a container from this image. +To help you get started creating a container from this image you can either use docker-compose or the docker cli. -### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose)) - -Compatible with docker-compose v2 schemas. +### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) ```yaml --- @@ -61,9 +68,9 @@ services: restart: unless-stopped ``` -### docker cli +### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/)) -``` +```bash docker run -d \ --name=minisatip \ -e PUID=1000 \ @@ -84,7 +91,6 @@ docker run -d \ In some cases it might be necessary to start minisatip with additional parameters, for example to configure a unicable LNB. Add the parameters you need and restart the container. Be sure to have the right parameters set as adding the wrong once might lead to the container not starting correctly. For a list of minisatip parameters visit [Minisatip](https://github.com/catalinii/minisatip) page. - ## 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. @@ -97,7 +103,6 @@ Docker images are configured using parameters passed at runtime (such as those a | `554` | RTSP Port | | `1900/udp` | App Discovery | - ### Environment Variables (`-e`) | Env | Function | @@ -113,19 +118,19 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `/config` | Configuration files and minisatip data | -#### Device Mappings (`--device`) +### Device Mappings (`--device`) + | Parameter | Function | | :-----: | --- | | `/dev/dvb` | For passing through Tv-cards | - ## Environment variables from files (Docker secrets) You can set any environment variable from a file by using a special prepend `FILE__`. As an example: -``` +```bash -e FILE__PASSWORD=/run/secrets/mysecretpassword ``` @@ -136,7 +141,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/ 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. - ## 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`. @@ -145,26 +149,17 @@ Ensure any volume directories on the host are owned by the same user you specify In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -``` +```bash $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` -## Application Setup - -Best used in conjunction with [tvheadend](https://github.com/linuxserver/docker-tvheadend) - -There is no setup per se, other than adding your cards for passthrough. - -You can then use your cards as DVB inputs in apps such as tvheadend. - - ## Docker Mods + [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=minisatip&query=%24.mods%5B%27minisatip%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=minisatip "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.") 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. - ## Support Info * Shell access whilst the container is running: