kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
cd9e15f63b
commit
0738a6d7b4
|
|
@ -1,6 +1,14 @@
|
|||
# linuxserver/oscam
|
||||
# [linuxserver/oscam](https://github.com/linuxserver/docker-oscam)
|
||||
|
||||
[](https://github.com/linuxserver/docker-oscam) [](https://github.com/linuxserver/docker-oscam/releases) [](https://github.com/linuxserver/docker-oscam/packages) [](https://gitlab.com/Linuxserver.io/docker-oscam/container_registry) [](https://microbadger.com/images/linuxserver/oscam) [](https://hub.docker.com/r/linuxserver/oscam) [](https://hub.docker.com/r/linuxserver/oscam) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-oscam/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/oscam/latest/index.html)
|
||||
[](https://github.com/linuxserver/docker-oscam)
|
||||
[](https://github.com/linuxserver/docker-oscam/releases)
|
||||
[](https://github.com/linuxserver/docker-oscam/packages)
|
||||
[](https://gitlab.com/Linuxserver.io/docker-oscam/container_registry)
|
||||
[](https://microbadger.com/images/linuxserver/oscam "Get your own version badge on microbadger.com")
|
||||
[](https://hub.docker.com/r/linuxserver/oscam)
|
||||
[](https://hub.docker.com/r/linuxserver/oscam)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-oscam/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/oscam/latest/index.html)
|
||||
|
||||
[Oscam](http://www.streamboard.tv/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.
|
||||
|
||||
|
|
@ -13,18 +21,19 @@ Simply pulling `linuxserver/oscam` should retrieve the correct image for your ar
|
|||
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=oscam \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -39,7 +48,8 @@ docker create \
|
|||
|
||||
### Passing through Smart Card Readers
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -57,6 +67,7 @@ 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.
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -83,41 +94,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 `<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.
|
||||
Docker images 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.
|
||||
|
||||
### Ports \(`-p`\)
|
||||
### Ports (`-p`)
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `8888` | 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 EG Europe/London. |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `/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\)
|
||||
|
||||
## Environment variables from files (Docker secrets)
|
||||
|
||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||
|
||||
As an example:
|
||||
|
||||
```text
|
||||
```
|
||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||
```
|
||||
|
||||
|
|
@ -125,30 +137,34 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
|||
|
||||
## Umask for running applications
|
||||
|
||||
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.
|
||||
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`.
|
||||
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)
|
||||
```
|
||||
|
||||
## 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.
|
||||
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
|
||||
[](https://mods.linuxserver.io/?mod=oscam "view available mods for this container.")
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=oscam)
|
||||
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) can be accessed via the dynamic badge above.
|
||||
|
||||
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\) can be accessed via the dynamic badge above.
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -169,7 +185,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
|||
* **28.04.19:** - Switch back to streamboard svn to fix version not showing in UI.
|
||||
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
|
||||
* **19.02.19:** - Add pipeline logic and multi arch, rebase to Alpine 3.8.
|
||||
* **03.01.18:** - Deprecate cpu\_core routine lack of scaling.
|
||||
* **03.01.18:** - Deprecate cpu_core routine lack of scaling.
|
||||
* **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.
|
||||
|
|
@ -178,4 +194,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
|||
* **14.10.16:** - Add version layer information.
|
||||
* **02.10.16:** - Add info on passing through devices to README.
|
||||
* **25.09.16:** - Initial release.
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue