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.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

230 lines
12 KiB

4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
  1. [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
  2. [![Blog](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
  3. [![Discord](https://img.shields.io/discord/354974912613449730.svg?style=flat-square&color=E68523&label=Discord&logo=discord&logoColor=FFFFFF)](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.")
  4. [![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?style=flat-square&color=E68523&logo=discourse&logoColor=FFFFFF)](https://discourse.linuxserver.io "post on our community forum.")
  5. [![Fleet](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Fleet)](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.")
  6. [![Podcast](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Podcast)](https://anchor.fm/linuxserverio "on hiatus. Coming back soon (late 2018).")
  7. [![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?style=flat-square&color=E68523&label=Open%20Collective%20Supporters)](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget")
  8. The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
  9. * regular and timely application updates
  10. * easy user mappings (PGID, PUID)
  11. * custom base image with s6 overlay
  12. * weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
  13. * regular security updates
  14. Find us at:
  15. * [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
  16. * [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
  17. * [Discourse](https://discourse.linuxserver.io) - post on our community forum.
  18. * [Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images.
  19. * [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
  20. * [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget
  21. # [linuxserver/oscam](https://github.com/linuxserver/docker-oscam)
  22. [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-oscam.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-oscam/releases)
  23. [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/oscam.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/oscam "Get your own version badge on microbadger.com")
  24. [![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/oscam.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/oscam "Get your own version badge on microbadger.com")
  25. [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/oscam.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/oscam)
  26. [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/oscam.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/oscam)
  27. [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-oscam/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-oscam/job/master/)
  28. [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/oscam/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/oscam/latest/index.html)
  29. [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.
  30. [![oscam](http://download.oscam.cc/images/Logo.png)](http://www.streamboard.tv/oscam/)
  31. ## Supported Architectures
  32. 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/).
  33. Simply pulling `linuxserver/oscam` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
  34. The architectures supported by this image are:
  35. | Architecture | Tag |
  36. | :----: | --- |
  37. | x86-64 | amd64-latest |
  38. | arm64 | arm64v8-latest |
  39. | armhf | arm32v7-latest |
  40. ## Usage
  41. Here are some example snippets to help you get started creating a container.
  42. ### docker
  43. ```
  44. docker create \
  45. --name=oscam \
  46. -e PUID=1000 \
  47. -e PGID=1000 \
  48. -e TZ=Europe/London \
  49. -p 8888:8888 \
  50. -v <path to data>:/config \
  51. --device /dev/ttyUSB0:/dev/ttyUSB0 \
  52. --restart unless-stopped \
  53. linuxserver/oscam
  54. ```
  55. ### Passing through Smart Card Readers
  56. 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.
  57. 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.
  58. 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.
  59. `/dev/bus/usb/001/001`
  60. 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.
  61. Here is an example of how to find the Bus and Device. The output of the lsusb command is below.
  62. `Bus 002 Device 005: ID 076b:6622 OmniKey AG CardMan 6121`
  63. The first number, the Bus, is 002. The second number, the Device, is 005. This will look like below in the `--device=` tag.
  64. `--device=/dev/bus/usb/002/005`
  65. If you have multiple smart card readers, you add one `--device=` tag for each reader.
  66. ### docker-compose
  67. Compatible with docker-compose v2 schemas.
  68. ```
  69. ---
  70. version: "2"
  71. services:
  72. oscam:
  73. image: linuxserver/oscam
  74. container_name: oscam
  75. environment:
  76. - PUID=1000
  77. - PGID=1000
  78. - TZ=Europe/London
  79. volumes:
  80. - <path to data>:/config
  81. ports:
  82. - 8888:8888
  83. devices:
  84. - /dev/ttyUSB0:/dev/ttyUSB0
  85. restart: unless-stopped
  86. ```
  87. ## Parameters
  88. Container 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.
  89. | Parameter | Function |
  90. | :----: | --- |
  91. | `-p 8888` | WebUI |
  92. | `-e PUID=1000` | for UserID - see below for explanation |
  93. | `-e PGID=1000` | for GroupID - see below for explanation |
  94. | `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
  95. | `-v /config` | Where oscam should store config files and logs. |
  96. | `--device /dev/ttyUSB0` | For passing through smart card readers. |
  97. ## User / Group Identifiers
  98. 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`.
  99. Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
  100. In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
  101. ```
  102. $ id username
  103. uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
  104. ```
  105. &nbsp;
  106. ## Application Setup
  107. To set up oscam there are numerous guides on the internet. There are too many scenarios to make a quick guide.
  108. The web interface is at port 8888.
  109. ## Support Info
  110. * Shell access whilst the container is running: `docker exec -it oscam /bin/bash`
  111. * To monitor the logs of the container in realtime: `docker logs -f oscam`
  112. * container version number
  113. * `docker inspect -f '{{ index .Config.Labels "build_version" }}' oscam`
  114. * image version number
  115. * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/oscam`
  116. ## Updating Info
  117. Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), 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.
  118. Below are the instructions for updating containers:
  119. ### Via Docker Run/Create
  120. * Update the image: `docker pull linuxserver/oscam`
  121. * Stop the running container: `docker stop oscam`
  122. * Delete the container: `docker rm oscam`
  123. * Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
  124. * Start the new container: `docker start oscam`
  125. * You can also remove the old dangling images: `docker image prune`
  126. ### Via Docker Compose
  127. * Update all images: `docker-compose pull`
  128. * or update a single image: `docker-compose pull oscam`
  129. * Let compose update all containers as necessary: `docker-compose up -d`
  130. * or update a single container: `docker-compose up -d oscam`
  131. * You can also remove the old dangling images: `docker image prune`
  132. ### Via Watchtower auto-updater (especially useful if you don't remember the original parameters)
  133. * Pull the latest image at its tag and replace it with the same env variables in one run:
  134. ```
  135. docker run --rm \
  136. -v /var/run/docker.sock:/var/run/docker.sock \
  137. containrrr/watchtower \
  138. --run-once oscam
  139. ```
  140. **Note:** We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.
  141. * You can also remove the old dangling images: `docker image prune`
  142. ## Building locally
  143. If you want to make local modifications to these images for development purposes or just to customize the logic:
  144. ```
  145. git clone https://github.com/linuxserver/docker-oscam.git
  146. cd docker-oscam
  147. docker build \
  148. --no-cache \
  149. --pull \
  150. -t linuxserver/oscam:latest .
  151. ```
  152. The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
  153. ```
  154. docker run --rm --privileged multiarch/qemu-user-static:register --reset
  155. ```
  156. Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
  157. ## Versions
  158. * **29.04.19:** - Add revision check, so pipeline can build new revisions.
  159. * **28.04.19:** - Switch back to streamboard svn to fix version not showing in UI.
  160. * **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
  161. * **19.02.19:** - Add pipeline logic and multi arch, rebase to Alpine 3.8.
  162. * **03.01.18:** - Deprecate cpu_core routine lack of scaling.
  163. * **13.12.17:** - Rebase to alpine 3.7.
  164. * **19.10.17:** - Add ccid package for usb card readers.
  165. * **17.10.17:** - Switch to using bzr for source code, streamboard awol.
  166. * **28.05.17:** - Rebase to alpine 3.6.
  167. * **09.02.17:** - Rebase to alpine 3.5.
  168. * **14.10.16:** - Add version layer information.
  169. * **02.10.16:** - Add info on passing through devices to README.
  170. * **25.09.16:** - Initial release.