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.

191 lines
8.9 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. The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
  3. * regular and timely application updates
  4. * easy user mappings (PGID, PUID)
  5. * custom base image with s6 overlay
  6. * weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
  7. * regular security updates
  8. Find us at:
  9. * [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
  10. * [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
  11. * [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
  12. * [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
  13. # PSA: Changes are happening
  14. From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag.
  15. TLDR: Multi-arch support is changing from multiple repos to one repo per container image.
  16. # [linuxserver/oscam](https://github.com/linuxserver/docker-oscam)
  17. [![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
  18. [![](https://images.microbadger.com/badges/version/linuxserver/oscam.svg)](https://microbadger.com/images/linuxserver/oscam "Get your own version badge on microbadger.com")
  19. [![](https://images.microbadger.com/badges/image/linuxserver/oscam.svg)](https://microbadger.com/images/linuxserver/oscam "Get your own version badge on microbadger.com")
  20. ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/oscam.svg)
  21. ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/oscam.svg)
  22. [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-oscam/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-oscam/job/master/)
  23. [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/oscam/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/oscam/latest/index.html)
  24. [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.
  25. [![oscam](http://download.oscam.cc/images/Logo.png)](http://www.streamboard.tv/oscam/)
  26. ## Supported Architectures
  27. 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).
  28. Simply pulling `linuxserver/oscam` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
  29. The architectures supported by this image are:
  30. | Architecture | Tag |
  31. | :----: | --- |
  32. | x86-64 | amd64-latest |
  33. | arm64 | arm64v8-latest |
  34. | armhf | arm32v6-latest |
  35. ## Usage
  36. Here are some example snippets to help you get started creating a container.
  37. ### docker
  38. ```
  39. docker create \
  40. --name=oscam \
  41. -e PUID=1001 \
  42. -e PGID=1001 \
  43. -e TZ=Europe/London \
  44. -p 8888:8888 \
  45. -v <path to data>:/config \
  46. --device /dev/ttyUSB0:/dev/ttyUSB0 \
  47. --restart unless-stopped \
  48. linuxserver/oscam
  49. ```
  50. ### Passing through Smart Card Readers
  51. 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.
  52. 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.
  53. 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.
  54. `/dev/bus/usb/001/001`
  55. 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.
  56. Here is an example of how to find the Bus and Device. The output of the lsusb command is below.
  57. `Bus 002 Device 005: ID 076b:6622 OmniKey AG CardMan 6121`
  58. The first number, the Bus, is 002. The second number, the Device, is 005. This will look like below in the `--device=` tag.
  59. `--device=/dev/bus/usb/002/005`
  60. If you have multiple smart card readers, you add one `--device=` tag for each reader.
  61. ### docker-compose
  62. Compatible with docker-compose v2 schemas.
  63. ```
  64. ---
  65. version: "2"
  66. services:
  67. oscam:
  68. image: linuxserver/oscam
  69. container_name: oscam
  70. environment:
  71. - PUID=1001
  72. - PGID=1001
  73. - TZ=Europe/London
  74. volumes:
  75. - <path to data>:/config
  76. ports:
  77. - 8888:8888
  78. devices:
  79. - /dev/ttyUSB0:/dev/ttyUSB0
  80. mem_limit: 4096m
  81. restart: unless-stopped
  82. ```
  83. ## Parameters
  84. 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.
  85. | Parameter | Function |
  86. | :----: | --- |
  87. | `-p 8888` | WebUI |
  88. | `-e PUID=1001` | for UserID - see below for explanation |
  89. | `-e PGID=1001` | for GroupID - see below for explanation |
  90. | `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
  91. | `-v /config` | Where oscam should store config files and logs. |
  92. | `--device /dev/ttyUSB0` | For passing through smart card readers. |
  93. ## User / Group Identifiers
  94. 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`.
  95. Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
  96. In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
  97. ```
  98. $ id username
  99. uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
  100. ```
  101. &nbsp;
  102. ## Application Setup
  103. To set up oscam there are numerous guides on the internet. There are too many scenarios to make a quick guide.
  104. The web interface is at port 8888.
  105. ## Support Info
  106. * Shell access whilst the container is running: `docker exec -it oscam /bin/bash`
  107. * To monitor the logs of the container in realtime: `docker logs -f oscam`
  108. * container version number
  109. * `docker inspect -f '{{ index .Config.Labels "build_version" }}' oscam`
  110. * image version number
  111. * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/oscam`
  112. ## Updating Info
  113. 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.
  114. Below are the instructions for updating containers:
  115. ### Via Docker Run/Create
  116. * Update the image: `docker pull linuxserver/oscam`
  117. * Stop the running container: `docker stop oscam`
  118. * Delete the container: `docker rm oscam`
  119. * 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)
  120. * Start the new container: `docker start oscam`
  121. * You can also remove the old dangling images: `docker image prune`
  122. ### Via Docker Compose
  123. * Update the image: `docker-compose pull linuxserver/oscam`
  124. * Let compose update containers as necessary: `docker-compose up -d`
  125. * You can also remove the old dangling images: `docker image prune`
  126. ## Versions
  127. * **19.02.19:** - Add pipeline logic and multi arch, rebase to Alpine 3.8.
  128. * **03.01.18:** - Deprecate cpu_core routine lack of scaling.
  129. * **13.12.17:** - Rebase to alpine 3.7.
  130. * **19.10.17:** - Add ccid package for usb card readers.
  131. * **17.10.17:** - Switch to using bzr for source code, streamboard awol.
  132. * **28.05.17:** - Rebase to alpine 3.6.
  133. * **09.02.17:** - Rebase to alpine 3.5.
  134. * **14.10.16:** - Add version layer information.
  135. * **02.10.16:** - Add info on passing through devices to README.
  136. * **25.09.16:** - Initial release.