README

   1 OSCam: Open Source Conditional Access Module
   2 ============================================
   3
   4
   5 License
   6 =======
   7
   8 OSCam: Open Source CAM
   9 Copyright (C) 2009-2024 OSCam developers
  10
  11 OSCam is based on the Streamboard mp-cardserver 0.9d by dukat and
  12 has been extended and worked on by many more since then.
  13
  14 This program is free software: you can redistribute it and/or modify
  15 it under the terms of the GNU General Public License as published by
  16 the Free Software Foundation, either version 3 of the License, or
  17 (at your option) any later version.
  18
  19 This program is distributed in the hope that it will be useful,
  20 but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 GNU General Public License for more details.
  23
  24 You should have received a copy of the GNU General Public License
  25 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  26
  27 For the full text of the licese, please read COPYING file in OSCam
  28 top directory or visit http://www.gnu.org/licenses/gpl-3.0.html
  29
  30
  31 Version history
  32 ===============
  33
  34 OSCam history is accessible through Trac timeline at:
  35    https://trac.streamboard.tv/oscam/timeline
  36
  37
  38 Repositories
  39 ============
  40
  41 SVN repository:
  42    svn checkout https://svn.streamboard.tv/oscam/trunk oscam-svn
  43
  44
  45 Building OSCam from source
  46 ==========================
  47
  48  - Get the lastest sources from SVN
  49     svn checkout https://svn.streamboard.tv/oscam/trunk oscam-trunk
  50
  51  - Go to oscam-trunk directory.
  52
  53  - Run `make config` to choose the features you want.
  54
  55  - Run `make` to compile OSCam.
  56
  57 For more information and examples on using the build system, please
  58 see README.build and README.config files.
  59
  60
  61 Building OScam for different CPUs (cross-compilation)
  62 =====================================================
  63
  64 First you need to install the target CPU toolchain. Already built toolchains
  65 for various architectures can be downloaded from:
  66
  67     https://trac.streamboard.tv/oscam/wiki/crosscompiling
  68
  69 In order to cross compile OSCam you need to set CROSS variable when
  70 running make. For example to compile for SH4 architecture you need
  71 to run: `make CROSS=sh4-linux-` or if your cross compilers are not
  72 in your PATH - `make CROSS=/opt/STM/STLinux-2.3/devkit/sh4/bin/sh4-linux-`.
  73
  74
  75 Dependencies
  76 ============
  77
  78 OSCam by default do not depend on external libraries except when compilation
  79 with SSL is requested. In that case openssl (libcrypto) library must be
  80 installed.
  81
  82 OSCam supports building with the following external dependencies:
  83   - libcrypto (libssl) - 'make USE_LIBCRYPTO=1'
  84   - libusb             - 'make USE_LIBUSB=1'
  85   - PCSC               - 'make USE_PCSC=1'
  86   - SH4 STAPI support  - 'make USE_STAPI=1'
  87   - SH4 STAPI5 support - 'make USE_STAPI5=1'
  88   - Coolapi support    - 'make USE_COOLAPI=1'
  89   - AZBOX support      - 'make USE_AZBOX=1'
  90
  91 For STAPI support you need to download liboscam_stapi.a library and place
  92 it in stapi directory under oscam/ root dir. liboscam_stapi.a can be downloaded
  93 from: https://board.streamboard.tv
  94
  95 For STAPI5 support you need to download liboscam_stapi5.a library and place
  96 it in stapi directory under oscam/ root dir. liboscam_stapi5.a can be downloaded
  97 from: https://board.streamboard.tv
  98
  99 For more information and examples on using the build system, run `make help`.
 100
 101
 102 Help and Support
 103 ================
 104
 105 man pages and configuration examples are in Distribution/doc directory.
 106
 107 You may visit our Trac system for tracking and filling bug reports.
 108    https://trac.streamboard.tv/oscam/newticket
 109
 110 If you experience any problems with OSCam, feel free to post in our support
 111 forum under (mainly German and English language) at:
 112    https://board.streamboard.tv/forum/
 113
 114 Configuration wiki:
 115    https://wiki.streamboard.tv/wiki/OSCam