docker-documentation/docs/images/docker-oscam.md

382 wiersze
15 KiB
Markdown

2021-02-15 14:53:08 +00:00
---
title: oscam
2025-01-30 17:36:01 +00:00
tags:
- Media Tools
description: "[Oscam](https://git.streamboard.tv/common/oscam) is an Open Source Conditional Access Module software used for descrambling DVB transmissions using smart cards. It's both a server and a client."
2021-02-15 14:53:08 +00:00
---
2023-10-13 09:13:17 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read https://github.com/linuxserver/docker-oscam/blob/master/.github/CONTRIBUTING.md -->
2020-07-03 11:32:59 +00:00
# [linuxserver/oscam](https://github.com/linuxserver/docker-oscam)
2024-05-24 09:17:20 +00:00
[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Foscam?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh)
2020-07-03 11:32:59 +00:00
[![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)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-oscam.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-oscam/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-oscam/packages)
2020-12-16 18:43:45 +00:00
[![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-oscam/container_registry)
2021-10-10 19:03:50 +00:00
[![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/oscam)
2020-07-03 11:32:59 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/oscam.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/oscam)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/oscam.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/oscam)
[![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-oscam%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-oscam/job/master/)
2020-11-02 19:55:45 +00:00
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Foscam%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/oscam/latest/index.html)
2019-02-27 22:53:39 +00:00
2024-05-18 13:40:24 +00:00
[Oscam](https://git.streamboard.tv/common/oscam) is an Open Source Conditional Access Module software used for descrambling DVB transmissions using smart cards. It's both a server and a client.
2019-02-27 22:53:39 +00:00
2024-05-18 13:40:24 +00:00
[![oscam](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/oscam-logo.png)](https://git.streamboard.tv/common/oscam)
2023-10-13 09:13:17 +00:00
2019-02-27 22:53:39 +00:00
## Supported Architectures
2023-11-17 09:12:14 +00:00
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2019-02-27 22:53:39 +00:00
2022-05-05 13:59:47 +00:00
Simply pulling `lscr.io/linuxserver/oscam:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-27 22:53:39 +00:00
The architectures supported by this image are:
2022-05-05 13:59:47 +00:00
| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\<version tag\> |
| arm64 | ✅ | arm64v8-\<version tag\> |
2023-07-07 09:14:48 +00:00
| armhf | ❌ | |
2019-02-27 22:53:39 +00:00
2021-04-22 14:01:31 +00:00
## Application Setup
To set up oscam there are numerous guides on the internet. There are too many scenarios to make a quick guide.
2023-03-15 15:21:30 +00:00
The web interface is at port 8888. You can find the project wiki [here](https://trac.streamboard.tv/oscam/).
2020-07-03 11:32:59 +00:00
2019-02-27 22:53:39 +00:00
## Usage
2021-10-10 19:03:50 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2019-02-27 22:53:39 +00:00
2024-12-06 09:22:06 +00:00
!!! info
Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.
2021-10-10 19:03:50 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2020-10-09 11:33:02 +00:00
```yaml
---
services:
oscam:
2022-05-05 13:59:47 +00:00
image: lscr.io/linuxserver/oscam:latest
2020-10-09 11:33:02 +00:00
container_name: oscam
environment:
- PUID=1000
- PGID=1000
2023-02-16 13:55:39 +00:00
- TZ=Etc/UTC
2020-10-09 11:33:02 +00:00
volumes:
2024-03-04 19:59:25 +00:00
- /path/to/oscam/data:/config
2020-10-09 11:33:02 +00:00
ports:
- 8888:8888
devices:
- /dev/ttyUSB0:/dev/ttyUSB0
restart: unless-stopped
```
2021-10-10 19:03:50 +00:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2019-02-27 22:53:39 +00:00
2021-04-22 14:01:31 +00:00
```bash
2020-10-09 11:33:02 +00:00
docker run -d \
2019-02-27 22:53:39 +00:00
--name=oscam \
2019-03-08 12:32:44 +00:00
-e PUID=1000 \
-e PGID=1000 \
2023-02-16 13:55:39 +00:00
-e TZ=Etc/UTC \
2019-02-27 22:53:39 +00:00
-p 8888:8888 \
2024-03-04 19:59:25 +00:00
-v /path/to/oscam/data:/config \
2019-02-27 22:53:39 +00:00
--device /dev/ttyUSB0:/dev/ttyUSB0 \
--restart unless-stopped \
2022-05-05 13:59:47 +00:00
lscr.io/linuxserver/oscam:latest
2019-02-27 22:53:39 +00:00
```
### Passing through Smart Card Readers
2020-07-03 11:32:59 +00:00
If you want to pass through a smart card reader, you need to specify the reader with the `--device=` tag. The method used depends on how the reader is recognized.
The first is /dev/ttyUSBX. To find the correct device, connect the reader and run `dmesg | tail` on the host. In the output you will find /dev/ttyUSBX, where X is the number of the device. If this is the first reader you connect to your host, it will be /dev/ttyUSB0. If you add one more it will be /dev/ttyUSB1.
2019-02-27 22:53:39 +00:00
If there are no /dev/ttyUSBX device in `dmesg | tail`, you have to use the USB bus path. It will look similar to the below.
`/dev/bus/usb/001/001`
The important parts are the two numbers in the end. The first one is the Bus number, the second is the Device number. To find the Bus and Device number you have to run `lsusb` on the host, then find your USB device in the list and note the Bus and Device numbers.
Here is an example of how to find the Bus and Device. The output of the lsusb command is below.
`Bus 002 Device 005: ID 076b:6622 OmniKey AG CardMan 6121`
The first number, the Bus, is 002. The second number, the Device, is 005. This will look like below in the `--device=` tag.
`--device=/dev/bus/usb/002/005`
If you have multiple smart card readers, you add one `--device=` tag for each reader.
2023-10-13 09:13:17 +00:00
2019-02-27 22:53:39 +00:00
## Parameters
2023-10-13 09:13:17 +00:00
Containers 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.
2019-02-27 22:53:39 +00:00
2020-07-03 11:32:59 +00:00
### Ports (`-p`)
2019-02-27 22:53:39 +00:00
| Parameter | Function |
2020-07-03 11:32:59 +00:00
| :----: | --- |
2024-12-06 09:22:06 +00:00
| `8888:8888` | WebUI |
2019-02-27 22:53:39 +00:00
2020-07-03 11:32:59 +00:00
### Environment Variables (`-e`)
2019-02-27 22:53:39 +00:00
| Env | Function |
2020-07-03 11:32:59 +00:00
| :----: | --- |
2019-03-08 12:32:44 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2023-02-16 13:55:39 +00:00
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
2019-02-27 22:53:39 +00:00
2020-07-03 11:32:59 +00:00
### Volume Mappings (`-v`)
2019-02-27 22:53:39 +00:00
| Volume | Function |
2020-07-03 11:32:59 +00:00
| :----: | --- |
2019-02-27 22:53:39 +00:00
| `/config` | Where oscam should store config files and logs. |
2021-04-22 14:01:31 +00:00
### Device Mappings (`--device`)
2019-02-27 22:53:39 +00:00
| Parameter | Function |
2020-07-03 11:32:59 +00:00
| :-----: | --- |
2019-02-27 22:53:39 +00:00
| `/dev/ttyUSB0` | For passing through smart card readers. |
2021-10-10 19:03:50 +00:00
#### Miscellaneous Options
| Parameter | Function |
| :-----: | --- |
2020-07-03 11:32:59 +00:00
## Environment variables from files (Docker secrets)
2020-05-29 11:32:49 +00:00
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
2021-04-22 14:01:31 +00:00
```bash
2023-10-13 09:13:17 +00:00
-e FILE__MYVAR=/run/secrets/mysecretvariable
2020-05-29 11:32:49 +00:00
```
2023-10-13 09:13:17 +00:00
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
2020-05-29 11:32:49 +00:00
## Umask for running applications
2020-07-03 11:32:59 +00:00
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.
2019-02-27 22:53:39 +00:00
## User / Group Identifiers
2020-07-03 11:32:59 +00:00
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`.
2019-02-27 22:53:39 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2023-10-13 09:13:17 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
2019-02-27 22:53:39 +00:00
2021-04-22 14:01:31 +00:00
```bash
2023-10-13 09:13:17 +00:00
id your_user
```
Example output:
```text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
2019-02-27 22:53:39 +00:00
```
2020-04-10 11:33:05 +00:00
## Docker Mods
2021-04-22 14:01:31 +00:00
2020-10-09 11:33:02 +00:00
[![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.")
2020-04-10 11:33:05 +00:00
2020-10-09 11:33:02 +00:00
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.
2020-04-10 11:33:05 +00:00
2019-02-27 22:53:39 +00:00
## Support Info
2019-09-06 11:33:04 +00:00
* Shell access whilst the container is running:
2023-10-13 09:13:17 +00:00
```bash
docker exec -it oscam /bin/bash
```
2019-09-06 11:33:04 +00:00
* To monitor the logs of the container in realtime:
2023-10-13 09:13:17 +00:00
```bash
docker logs -f oscam
```
* Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' oscam
```
* Image version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/oscam:latest
```
## Updating Info
2024-01-12 09:15:14 +00:00
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
2023-10-13 09:13:17 +00:00
Below are the instructions for updating containers:
### Via Docker Compose
* Update images:
* All images:
```bash
docker-compose pull
```
* Single image:
```bash
docker-compose pull oscam
```
* Update containers:
* All containers:
```bash
docker-compose up -d
```
* Single container:
```bash
docker-compose up -d oscam
```
* You can also remove the old dangling images:
```bash
docker image prune
```
### Via Docker Run
* Update the image:
```bash
docker pull lscr.io/linuxserver/oscam:latest
```
* Stop the running container:
```bash
docker stop oscam
```
* Delete the container:
```bash
docker rm oscam
```
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
* You can also remove the old dangling images:
```bash
docker image prune
```
### Image Update Notifications - Diun (Docker Image Update Notifier)
2024-09-26 17:39:07 +00:00
!!! tip
2023-10-13 09:13:17 +00:00
We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
## Building locally
If you want to make local modifications to these images for development purposes or just to customize the logic:
```bash
git clone https://github.com/linuxserver/docker-oscam.git
cd docker-oscam
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/oscam:latest .
```
2024-11-13 02:00:33 +00:00
The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`
2023-10-13 09:13:17 +00:00
```bash
2024-11-13 02:00:33 +00:00
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
2023-10-13 09:13:17 +00:00
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
2019-02-27 22:53:39 +00:00
2024-12-15 19:30:10 +00:00
To help with development, we generate this dependency graph.
??? info "Init dependency graph"
```d2
"oscam:latest": {
docker-mods
base {
fix-attr +\nlegacy cont-init
}
docker-mods -> base
legacy-services
custom services
init-services -> legacy-services
init-services -> custom services
custom services -> legacy-services
legacy-services -> ci-service-check
init-migrations -> init-adduser
init-os-end -> init-config
init-config -> init-config-end
init-oscam-config -> init-config-end
init-os-end -> init-crontab-config
init-mods-end -> init-custom-files
base -> init-envfile
base -> init-migrations
base -> init-mods
init-config-end -> init-mods
init-mods -> init-mods-end
init-mods-package-install -> init-mods-end
init-mods -> init-mods-package-install
base -> init-os-end
init-adduser -> init-os-end
init-envfile -> init-os-end
init-migrations -> init-os-end
init-config -> init-oscam-config
init-custom-files -> init-services
init-mods-end -> init-services
init-services -> svc-cron
svc-cron -> legacy-services
svc-pcsd -> svc-oscam
svc-oscam -> legacy-services
init-services -> svc-pcsd
svc-pcsd -> legacy-services
}
Base Images: {
"baseimage-alpine:3.20"
}
"oscam:latest" <- Base Images
```
2019-02-27 22:53:39 +00:00
## Versions
2024-06-28 20:11:14 +00:00
* **27.06.24:** - Rebase to Alpine 3.20.
2024-05-18 13:40:24 +00:00
* **19.04.24:** - Retrieve Oscam from the new git repo.
2024-03-04 19:59:25 +00:00
* **04.03.24:** - Rebase to Alpine 3.19. Add libdvbcsa.
2023-08-27 14:37:38 +00:00
* **27.08.23:** - Rebase to Alpine 3.18. Pull PCSC driver from Linuxserver S3 due to Cloudflare blocking curl download of original file.
2023-07-07 09:14:48 +00:00
* **07.07.23:** - Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)
2023-03-15 15:21:30 +00:00
* **13.03.23:** - Rebase to Alpine 3.17.
2022-11-03 18:48:46 +00:00
* **03.11.22:** - Rebasing to alpine 3.16 and s6v3. Update pcsd driver link.
* **13.02.22:** - Rebasing to alpine 3.15.
2019-12-27 10:49:13 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-12-17 22:23:08 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-04-29 08:59:44 +00:00
* **29.04.19:** - Add revision check, so pipeline can build new revisions.
2019-04-28 21:53:00 +00:00
* **28.04.19:** - Switch back to streamboard svn to fix version not showing in UI.
2019-03-25 00:32:07 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-27 22:53:39 +00:00
* **19.02.19:** - Add pipeline logic and multi arch, rebase to Alpine 3.8.
2020-07-03 11:32:59 +00:00
* **03.01.18:** - Deprecate cpu_core routine lack of scaling.
2019-02-27 22:53:39 +00:00
* **13.12.17:** - Rebase to alpine 3.7.
* **19.10.17:** - Add ccid package for usb card readers.
* **17.10.17:** - Switch to using bzr for source code, streamboard awol.
* **28.05.17:** - Rebase to alpine 3.6.
* **09.02.17:** - Rebase to alpine 3.5.
* **14.10.16:** - Add version layer information.
* **02.10.16:** - Add info on passing through devices to README.
* **25.09.16:** - Initial release.