Differences

This shows you the differences between two versions of the page.

Link to this comparison view

public:gsoc:configuration_options [2016/08/02 20:06] (current)
Line 1: Line 1:
 +====== Configuration options ======
  
 +This document describes repository application and website configuration options
 +
 +===== Repository application config =====
 +
 +There are 3 ways to configure server application:​ config files, environment variables and command line arguments. ​ Options from config files can be overwritten by environment variables which can be overwritten by cmd arguments.
 +
 +To get a list of options'​ values that application will use in runtime, you can call it with //-a// or //<​nowiki>​--variables</​nowiki>//​ argument.
 +
 +Default location of config file is ///​etc/​ccr/​ccr.ini//,​ but its location can be overwritten. There is also separate config file ///​etc/​ccr/​db.ini//​ that canbe used for storing database connection parameters.
 +
 +Syntax of config file is similar to INI format:
 +  * One key-value pair per line separated by equal sign
 +  * Semi-column is used for comments
 +  * String values should be double-quoted
 +  * Boolean values is //​true/​false/​1/​0//​
 +
 +Bellow is a list of options supported by server application. Option name is represented by its name in config files, environment variable and command line argument.
 +
 +
 +**daemon**, env: **CC_DAEMON**,​ cmd: **<​nowiki>​--daemon</​nowiki>​**\\
 +Default: false\\
 +if true, server shall run as standalone daemon process.\\
 +
 +**db-host**,​ env: **CC_DB_HOST**,​ cmd: **<​nowiki>​--db-host</​nowiki>​**\\
 +MySQL server host.\\
 +
 +**db-user**,​ env: **CC_DB_USER**,​ cmd: **<​nowiki>​--db-user</​nowiki>​**\\
 +MySQL user name when connecting to the server.\\
 +
 +**db-password**,​ env: **CC_DB_PASSWORD**,​ cmd: **<​nowiki>​--db-password</​nowiki>​**\\
 +MySQL user password to use when connecting to the server.\\
 +
 +**db-name**,​ env: **CC_DB_NAME**,​ cmd: **<​nowiki>​--db-name</​nowiki>​**\\
 +MySQL database name to use.\\
 +
 +**db-timezone**,​ env: **CC_DB_TIMEZONE**,​ cmd: **<​nowiki>​--db-timezone</​nowiki>​**\\
 +Default: +00:00\\
 +MySQL database time-zone varable value.\\
 +
 +**port**, env: **CC_PORT**,​ cmd: **<​nowiki>​--port</​nowiki>​**\\
 +Default: 3030\\
 +TCP port for accepting CCExtractor connections.\\
 +
 +**password**,​ env: **CC_PASSWORD**,​ cmd: **<​nowiki>​--password</​nowiki>​**\\
 +The password clinets must use for their captions to accepted. If it's epmty, server doesn'​t require password.\\
 +
 +**ping-interval**,​ env: **CC_PING_INTERVAL**,​ cmd: **<​nowiki>​--ping-interval</​nowiki>​**\\
 +Default: 3\\
 +The interval (in seconds) between sending keep-alive pakets to the clinet.\\
 +
 +**ping-timeout**,​ env: **CC_PING_TIMEOUT**,​ cmd: **<​nowiki>​--ping-timeout</​nowiki>​**\\
 +Default: 20\\
 +The number of seconds server waits for keep-alive packets before closing connection.\\
 +
 +**pid-file**,​ env: **CC_PID_FILE**,​ cmd: **<​nowiki>​--pid-file</​nowiki>​**\\
 +Default: /​var/​run/​ccr.pid\\
 +Path to PID file when running in daemon mode.\\
 +
 +**config-file**,​ env: **CC_CONFIG_FILE**,​ cmd: **<​nowiki>​--config-file</​nowiki>​**\\
 +Default: /​etc/​ccr/​ccr.ini\\
 +Path to server'​s configuration file. (Note that this cmd argument doesn'​t work now)\\
 +
 +**db-config-file**,​ env: **CC_DB_CONFIG_FILE**,​ cmd: **<​nowiki>​--db-config-file</​nowiki>​**\\
 +Default: /​etc/​ccr/​db.ini\\
 +Path to database connection configuration file. (Note that this cmd argument doesn'​t work now)\\
 +
 +**error-log**,​ env: **CC_ERROR_LOG**,​ cmd: **<​nowiki>​--error-log</​nowiki>​**\\
 +Default: /​var/​log/​ccr-error.log\\
 +Path to the log file with errors.\\
 +
 +**debug-log**,​ env: **CC_DEBUG_LOG**,​ cmd: **<​nowiki>​--debug-log</​nowiki>​**\\
 +Default: /​var/​log/​ccr-debug.log\\
 +Path to the log file with debug messages. To create this file you should set --verbose option to true.\\
 +
 +**log-stderr**,​ env: **CC_LOG_STDERR**,​ cmd: **<​nowiki>​--log-stderr</​nowiki>​**\\
 +Default: false\\
 +If true log messages will be outputed to standart output (stdout) and no log files will be created. You can't use this option in daemon mode\\
 +
 +**verbose**,​ env: **CC_VERBOSE**,​ cmd: **<​nowiki>​--verbose</​nowiki>​**\\
 +Default: false\\
 +If true debug log messages will be printed in log file\\
 +
 +**web-buffer-dir**,​ env: **CC_WEB_BUFFER_DIR**,​ cmd: **<​nowiki>​--web-buffer-dir</​nowiki>​**\\
 +Default: /srv/web\\
 +Path to the directory shall contain website buffer files.\\
 +
 +**buffer-file-max-lines**,​ env: **CC_BUFFER_FILE_MAX_LINES**,​ cmd: **<​nowiki>​--buffer-file-max-lines</​nowiki>​**\\
 +Default: 200\\
 +The max number of lines in website buffer file. When number of lines reaches thisvalue, several first lines is removed so that the file contains '​buffer-file-min-lines'​ lines.\\
 +
 +**buffer-file-min-lines**,​ env: **CC_BUFFER_FILE_MIN_LINES**,​ cmd: **<​nowiki>​--buffer-file-min-lines</​nowiki>​**\\
 +Default: 100\\
 +The number of lines website buffer file will be cropped to when it reaches '​buffer-file-max-lines.'​\\
 +
 +**archive-dir**,​ env: **CC_ARCHIVE_DIR**,​ cmd: **<​nowiki>​--archive-dir</​nowiki>​**\\
 +Default: /​srv/​archive\\
 +Path to the directory that shall contain files with closed captions (.srt, .txt, .bin)\\
 +
 +**program-change-timeout**,​ env: **CC_PROGRAM_CHANGE_TIMEOUT**,​ cmd: **<​nowiki>​--program-change-timeout</​nowiki>​**\\
 +Default: 7200\\
 +The number of seconds untill current program is changed to unknown, (if no EPG is reported)\\
 +
 +**program-change-eps**,​ env: **CC_PROGRAM_CHANGE_EPS**,​ cmd: **<​nowiki>​--program-change-eps</​nowiki>​**\\
 +Default: 120\\
 +The maximum gap in seconds between adjacent EPG enevts. If the gap is large, current program is changed to undefined.\\
 +
 +**store-cc**,​ env: **CC_STORE_CC**,​ cmd: **<​nowiki>​--store-cc</​nowiki>​**\\
 +Default: true\\
 +If true, closed catptions will be stored in filesystem and in database. If it's false, database is still required for storing info about active connections.\\
 +
 +**ccextractor-path**,​ env: **CC_CCEXTRACTOR_PATH**,​ cmd: **<​nowiki>​--ccextractor-path</​nowiki>​**\\
 +Default: /​usr/​bin/​ccextractor\\
 +Path to CCExtractor executable.\\
 +
 +**ccextractor-output-dir**,​ env: **CC_CCEXTRACTOR_OUTPUT_DIR**,​ cmd: **<​nowiki>​--ccextractor-output-dir</​nowiki>​**\\
 +Default: /​tmp/​cce-output\\
 +Path to the directory that shall contain CCExtractor output files.\\
 +
 +**ccextractor-input-dir**,​ env: **CC_CCEXTRACTOR_INPUT_DIR**,​ cmd: **<​nowiki>​--ccextractor-input-dir</​nowiki>​**\\
 +Default: /​tmp/​cce-input\\
 +Path to the directory that shall contain CCExtractor intput files.\\
 +
 +===== Web pages config =====
 +
 +Web pages a configured using Apache environment variables. These variables can be set in //​web/​ccr.conf//​ file or in ///​etc/​httpd/​conf.d/​ccr.conf//​ after installation.
 +
 +Supported variables are:
 +  * **CC_DB_HOST** --- MySQL server host.
 +  * **CC_DB_NAME** --- MySQL database name to use.
 +  * **CC_DB_USER** --- MySQL user name when connecting to the server.
 +  * **CC_DB_PASSWORD** --- MySQL user password to use when connecting to the server. If it is not set, then empty password is used
  • public/gsoc/configuration_options.txt
  • Last modified: 2016/08/02 20:06
  • (external edit)