readme-vars.yml

---

# project information
project_name: oscam
project_url: "https://git.streamboard.tv/common/oscam"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/oscam-logo.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) is an Open Source Conditional Access Module software used for descrambling DVB transmissions using smart cards. It's both a server and a client."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
# supported architectures
available_architectures:
  - {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
# container parameters
common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/data", desc: "Where oscam should store config files and logs."}
param_usage_include_ports: true
param_ports:
  - {external_port: "8888", internal_port: "8888", port_desc: "WebUI"}
param_device_map: true
param_devices:
  - {device_path: "/dev/ttyUSB0", device_host_path: "/dev/ttyUSB0", desc: "For passing through smart card readers."}
# optional container parameters
optional_block_1: true
optional_block_1_items:
  - |
    ### 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 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.
# application setup block
app_setup_block_enabled: true
app_setup_block: |
  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. You can find the project wiki [here](https://trac.streamboard.tv/oscam/).
# init diagram
init_diagram: |
  "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
# changelog
changelogs:
  - {date: "27.06.24:", desc: "Rebase to Alpine 3.20."}
  - {date: "19.04.24:", desc: "Retrieve Oscam from the new git repo."}
  - {date: "04.03.24:", desc: "Rebase to Alpine 3.19. Add libdvbcsa."}
  - {date: "27.08.23:", desc: "Rebase to Alpine 3.18. Pull PCSC driver from Linuxserver S3 due to Cloudflare blocking curl download of original file."}
  - {date: "07.07.23:", desc: "Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)"}
  - {date: "13.03.23:", desc: "Rebase to Alpine 3.17."}
  - {date: "03.11.22:", desc: "Rebasing to alpine 3.16 and s6v3. Update pcsd driver link."}
  - {date: "13.02.22:", desc: "Rebasing to alpine 3.15."}
  - {date: "19.12.19:", desc: "Rebasing to alpine 3.11."}
  - {date: "28.06.19:", desc: "Rebasing to alpine 3.10."}
  - {date: "29.04.19:", desc: "Add revision check, so pipeline can build new revisions."}
  - {date: "28.04.19:", desc: "Switch back to streamboard svn to fix version not showing in UI."}
  - {date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag."}
  - {date: "19.02.19:", desc: "Add pipeline logic and multi arch, rebase to Alpine 3.8."}
  - {date: "03.01.18:", desc: "Deprecate cpu_core routine lack of scaling."}
  - {date: "13.12.17:", desc: "Rebase to alpine 3.7."}
  - {date: "19.10.17:", desc: "Add ccid package for usb card readers."}
  - {date: "17.10.17:", desc: "Switch to using bzr for source code, streamboard awol."}
  - {date: "28.05.17:", desc: "Rebase to alpine 3.6."}
  - {date: "09.02.17:", desc: "Rebase to alpine 3.5."}
  - {date: "14.10.16:", desc: "Add version layer information."}
  - {date: "02.10.16:", desc: "Add info on passing through devices to README."}
  - {date: "25.09.16:", desc: "Initial release."}