From 0d4f29ef7294d961184fe82e22252883081f0702 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Thu, 22 Apr 2021 14:01:31 +0000 Subject: [PATCH] Bot Updating Documentation --- images/docker-oscam.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/images/docker-oscam.md b/images/docker-oscam.md index 78ee656c3..6ec27ddfe 100644 --- a/images/docker-oscam.md +++ b/images/docker-oscam.md @@ -1,6 +1,9 @@ --- title: oscam --- + + + # [linuxserver/oscam](https://github.com/linuxserver/docker-oscam) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-oscam.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-oscam) @@ -29,6 +32,10 @@ The architectures supported by this image are: | arm64 | arm64v8-latest | | armhf | arm32v7-latest | +## Application Setup + +To set up oscam there are numerous guides on the internet. There are too many scenarios to make a quick guide. +The web interface is at port 8888. ## Usage @@ -60,7 +67,7 @@ services: ### docker cli -``` +```bash docker run -d \ --name=oscam \ -e PUID=1000 \ @@ -94,7 +101,6 @@ The first number, the Bus, is 002. The second number, the Device, is 005. This w If you have multiple smart card readers, you add one `--device=` tag for each reader. - ## 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. @@ -105,7 +111,6 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `8888` | WebUI | - ### Environment Variables (`-e`) | Env | Function | @@ -120,19 +125,19 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `/config` | Where oscam should store config files and logs. | -#### Device Mappings (`--device`) +### Device Mappings (`--device`) + | Parameter | Function | | :-----: | --- | | `/dev/ttyUSB0` | For passing through smart card readers. | - ## 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 ``` @@ -143,7 +148,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`. @@ -152,23 +156,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 - -To set up oscam there are numerous guides on the internet. There are too many scenarios to make a quick guide. -The web interface is at port 8888. - - ## Docker Mods + [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=oscam&query=%24.mods%5B%27oscam%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=oscam "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: