Changes

''Debian 6+:''

*'''Source''' - a program that accepts broadcast's HTTP-stream of broadcast and provides playback of broadcast viewing with a help of using ACE Stream software.*'''Support node''' - a program, allowing to scale broadcast, using additional server equipment and Internet-channels.

Broadcast organizing organization starts from launching the source (command <tt>acestreamengine-stream</tt>).The source accepts HTTP-stream to input(at this moment HTTP-streams with MPEG-TS encapsulation are supported) with the original of broadcast and creates a file with acelive extension after the launch. This file is a unique identifier of broadcast and it is used for connection and playback by clients.

===Синтаксис команды Syntax of acestreamengine--stream-source command===Команда <tt>acestreamengine--stream-source</tt> запускает источник трансляцииcommand launches broadcast source.

''обязательные параметрыrequired parameters''*<tt>--name NAME</tt> - название трансляции broadcast name (это название используется при создании файла this name is used when creating acelive и других служебных файловand other service files)*<tt>--source SOURCE</tt> - источник source (ссылка на link to http-потокstream)*<tt>--bitrate BITRATE</tt> - средний битрейт потока в байтах в секундуaverage bitrate of stream in bytes per second

''необязательные параметрыoptional parameters''*<tt>--title TITLE</tt> - "читабельноеreadable" название транляции broadcast name (это название выводится у клиентовthis name is shown to clients). Если не заданоIf it's not specified, берется из it's taken from --name*<tt>--destdir DESTDIR</tt> - устаревшний параметрold parameter, лучше использовать it's better to use --cache-dir и and --publish-dir*<tt>--cache-dir CACHE_DIR</tt> - папка для создания служебных файлов directory for creating service files (кеш трансляции и другиеbroadcast cache and others)*<tt>--publish-dir PUBLISH_DIR</tt> - папкаdirectory, в которой будет создан in which acelive-файлfile will be created*<tt>--piecesize PIECESIZE</tt> - размер куска в байтах piece size in bytes (если не заданif it's not specified, выставляется автоматически в зависимости от битрейтаit's set automatically depending on bitrate)*<tt>--duration DURATION</tt> - размер кеша трансляции в формат ЧЧsize of broadcast cache in format HH:ММMM:СС SS (по умолчанию один часby default, one hour: 01:00:00)*<tt>--host HOST</tt> - вручную задать адрес локального трекераset address of local tracker manually*<tt>--port PORT</tt> - портport, на котором работает движокwhere the engine works*<tt>--skip-internal-tracker</tt> - отключить локальный трекерdisable local tracker*<tt>--add-authorized-peers</tt> - добавить список авторизованных пиров в add list of authorized peers to acelive файлfile*<tt>--private-source</tt> - сделать источник приватнымmake the source private*<tt>--support-node SUPPORT_NODE</tt> - добавить узел поддержки add support node (в формате in format ip:port). Этот параметр может встречаться несколько раз, если нужно добавить несколько узлов поддержкиThis parameter may appear multiple times if several support nodes have to be added.*<tt>--tracker TRACKER</tt> - добавить трекер add tracker(announce url). Этот параметр может встречаться несколько разThis parameter may appear multiple times.*<tt>--trackers TRACKERS</tt> - старый формат добавления трекеров old format for adding trackers (список announce url через запятуюlist separated by commas)*<tt>--provider-key PROVIDER_KEY</tt> - ключ провайдера provider's key (только для коммерческих трансляцийonly for commercial broadcasts)*<tt>--maxclients MAXCLIENTS</tt> - максимальное количество пировmaximum number of peers, on which data from the source are given simultaneously*<tt>--log-debug DEBUG</tt> - set the debug level (default is 0 - minimum log level)*<tt>--source-read-timeout SECONDS</tt> - timeout for reading data from the original source (in seconds). Default is 30.*<tt>--source-reconnect-interval SECONDS</tt> - interval is seconds, на которые одновременно отдаются данные с источникаafter which the engine will try to reconnect to the original source in case of connection lost. Default is 5.*<tt>--pid-file-dir PATH</tt> - the directory where engine's pid file is created. Default is /tmp.*<tt>--provider-key</tt> - provider key (for an affiliate program)*<tt>--showsid</tt> - content identificator for statistics(for an affiliate program)*<tt>--piecespermanent</tt> - выводить в лог номера кусков по мере их созданияmark the broadcast as 24/7 (it's available all the time)*<tt>--showdate-start YYYY-MM-DD HH:mm:ss</tt> - set the data and time of the broadcast start (for the broadcasts which runs during a limited time)*<tt>--date-end YYYY-MM-DD HH:mm:ss</tt> - set the data and time of the broadcast end(for the broadcasts which runs during a limited time)*<tt>--premium</tt> - request a "premium" status for the broadcast*<tt>--upload-limit</tt> - limit upload speed (bytes/s, default is 0 - don't limit)*<tt>--max-connections</tt> - limit total number of connections (default is 1000)*<tt>--max-peers</tt> - limit number of connections to other peers(default is 50)*<tt>--service-remote-access</tt> - периодически выводить в лог список подключенных пировenable remote statistics*<tt>--debug DEBUGservice-access-token</tt> - password for remote statistics access*<tt>--stats-report-interval</tt> - interval in seconds between internal statistics update (default is 60)*<tt>--stats-report-peers</tt> - установить уровень отладкиupdate information about connected peers in the internal statistics (increases CPU load)

''дополнительноadditional''*<tt>-h, --help</tt> - показать описание командshow commands' description

===Синтаксис команды Syntax of acestreamengine--stream-nodecommand===Команда <tt>acestreamengine--stream-node</tt> запускает узел поддержкиcommand launches support node.

''обязательные параметрыrequired parameters''*<tt>--url URL></tt> - ссылка на link to acelive файл трансляцииfile of broadcast

''необязательные параметрыoptional parameters''*<tt>--port PORT</tt> - порт port(по умолчанию by default: 8621)*<tt>--state-dir STATE_DIR</tt> - папка для временных файлов directory for temporary files (удаляется после остановки узла поддержкиit's deleted after support node installation)*<tt>--source-node SOURCE_NODE</tt> - адрес источника трансляции address of broadcast source (ip:port)*<tt>--support-node SUPPORT_NODE</tt> - добавить адрес другого узла поддержки add address of another support node (ip:port). Этот параметр может встречаться несколько разThis parameter may appear multiple times.*<tt>--allow-source-download</tt> - разрешить получение данных от источникаallow receiving data from the source*<tt>--allow-support-download</tt> - разрешить получение данных от других узлов поддержкиallow receiving data from other support nodes*<tt>--allow-peers-download</tt> - разрешить получение данных от обычных пировallow receiving data from ordinary peers*<tt>--max-incoming-connects MAX_INCOMING_CONNECTSconnections MAX_CONNECTIONS</tt> - маскимальное кол-во входящих соединений (от других пиров) limit number of total connections (по умолчанию default is 1000)*<tt>--max-outgoing-connects MAX_OUTGOING_CONNECTSpeers MAX_PEERS</tt> - маскимальное кол-во исходящих соединений limit number of connections to other peers (к другим пирам) (по умолчанию default is 50)*<tt>--max-upload-slots MAX_UPLOAD_SLOTS</tt> - максимальное количество пировmaximum number of peers, на которые одновременно отдаются данные с узла поддержки on which data from support node are given simultaneously (по умолчанию by default: 7)*<tt>--max-download-speed MAX_DOWNLOAD_SPEED</tt> - максимальная скорость загрузки maximum download speed (байтbyte/сs). По умолчанию By default: 0 (без ограниченийno restrictions).*<tt>--max-upload-speed MAX_UPLOAD_SPEED</tt> - максимальная скорость отдачи maximum upload speed (байсbyte/сs). По умолчанию By default: 0 (без ограниченийno restrictions).*<tt>--showlog-debug DEBUG</tt> - set the debug level (default is 0 - minimum log level)*<tt>--service-remote-piecesaccess</tt> - выводить в лог номера кусков по мере их загрузкиenable remote statistics*<tt>--showservice-peersaccess-token</tt> - периодически выводить в лог список подключенных пировpassword for remote statistics access*<tt>--stats-report-interval STATS_REPORT_INTERVAL</tt> - задать интервал в секундах для вывода в лог информации о скорости загрузки/отдачи. По умолчанию 0 interval in seconds between internal statistics update (не выводитьdefault is 60).*<tt>--debug DEBUGstats-report-peers</tt> - установить уровень отладкиupdate information about connected peers in the internal statistics (increases CPU load)

''дополнительноadditional''*<tt>-h, --help</tt> - показать описание командshow commands' description

===Встроенный трекерEmbedded tracker===Встроенный трекер - это трекер встроенный в источник трансляцииEmbedded tracker is a tracker embedded into broadcast source. Если он не отключен опцией If it's not disabled by <tt>--skip-internal-tracker</tt>option, то его адрес будет автоматически добавлен в its address will be added to acelive-файлfile automatically.

При организации трансляций с большим количеством пользователей мы рекомендуем отключать встроенный трекер и заменять его внешним трекером с хорошей производительностью When organizing broadcast with many users, we recommend to disable embedded tracker and replace it with external tracker with a good productivity (напримерfor example, [http://xbtt.sourceforge.net/tracker/ XBT Tracker]).

===Авторизованные узлыAuthorized nodes===Для тогоClient have to establish connection with at least two other nodes or an authorized node, чтобы клиент подключился к трансляции и начал просмотр, ему необходимо либо установить соединение минимум с двумя другими узлами, либо установить соединение с авторизованным узломto be connected to broadcast and start playback. Авторизованный узел - это узел, который был отмечен создателем трансляции как такойAuthorized node is a node, которому можно which was marked by broadcast's creator as a "доверятьtrustworthy". Как правило, это источник трансляции иUsually it's a broadcast source and/или узлы поддержкиor support nodes.

Последние версии ПО The latest versions of ACE Stream поддерживают использование списка авторизованных узлов в software support using list of authorized nodes in acelive-файлеfile. Для этого при создании трансляции задается опция For this <tt>--add-authorized-peers</tt>option is set when creating broadcast, после чего формируется список авторизованных узлов и добавляется в after this the list of authorized nodes is created and added to acelive-файлfile. В список авторизованных узлов попадает источник трансляции Broadcast source (если это не приватный источникif it's not private) и все указанные узлы поддержкиand all specified support nodes are in the list of authorized nodes. Клиенты, которые получили данный Clients that received this acelive-файл, используют список для определения того, является ли какой-либо узел авторизованнымfile use the list to determine whether a node is authorized.

Если в If the list of authorized nodes was not added to acelive-файл не был добавлен список авторизованных узлов, либо у клиента установлена старая версия file or an old version of ACE Stream, которая не распознает данный списокwhich doesn't understand this list, is installed, то авторизованным узлом считается узелthen authorized node is a node, IP адрес которого совпадает с адресом первого трекера в списке трекеровaddress of which matches address of the first tracker from trackers' list. Если встроенный трекер на источнике не отключенIf embedded tracker is enabled on the source, то он будет первым в списке и клиенты будут считать источник авторизованным узломit will be the first one on the list and clients will consider the source as authorized node. В случае, если встроенный трекер отключенIf embedded tracker is disabled, для поддержки старых клиентов мы рекомендуем ставить на первое место трекерto support other clients we recommend to put on the first place tracker, расположенный на том же сервере, что и источник трансляции located on the same server as broadcast source (чтобы адреса первого трекера и источника совпадалиso addresses of the first tracker and the source matched)or use at least one support node (so clients, либо использовать как минимум один узел поддержки (чтобы клиенты при старте могли установить соединение сразу с двумя пирамиwhen starting broadcast, could connect to two peers simultaneously, даже если больше никто не смотрит трансляциюeven if nobody watches broadcast).

===ПримерыExamples===Для примеров предроложим наличие локальной сети с тремя серверамиFor examples let's assume that there is a local network with three servers:*192.168.1.1 - сервер для источникаserver for the source*192.168.1.2 - сервер для узла поддержкиserver for support node*192.168.1.3 - сервер для узла поддержкиserver for support node*192.168.1.100 - сервер, который отдает оригинальный поток трансляции server that gives original broadcast's stream (HTTP MPEG-TS) по адресу at <nowiki>http://192.168.1.100/stream</nowiki> (средний битрейт потока average bitrate of stream - 300 000 байтbyte/сs)

На сервере It's assumed that on server 192.168.1.1 предполагается наличие вебthere is a web-сервера с корневой папкой server with a core directory <tt>/home/www</tt>, а также двух папокand two other directories:*<tt>/home/www/streams</tt> - для хранения for keeping acelive-файловfiles, которые будут доступны для скачивания по ссылке вида which will be available for downloading by a link like <tt><nowiki>http://192.168.1.1/streams/test.acelive</nowiki></tt>*<tt>/tmp/streams</tt> - для хранения кэша и служебных файлов трансляцийfor keeping cache and service files of broadcast

====Источник с встроенным трекеромSource with embedded tracker====Это наиболее простой способ запуск трансляции, не требующий запуска узлов поддержки и установки дополнительных трекеровThis is the easiest way to launch broadcast that does not require launching support nodes and installing additional trackers. Данный способ подходит для трансляций с небольшим количество пользователейThis method is suitable for broadcasts with a small number of users.

На сервере We launch the source on server 192.168.1.1 запускаем источник: <tt>acestreamengine--stream -source \

--title "Тестовая трансляцияTest broadcast" \

--add-authorized-peers \ > /tmp/test-source.log 2>&1</tt>

Последняя строка используется для записи логов в файл The last line is used to write logs into file /tmp/test-source.log. By default <tt>acestreamengine--stream-source</tt> выводит всю отладочную информацию на консоль в STDERRoutputs all debug information in the STDOUT.

Опция <tt>--add-authorized-peers</tt> добавляет в option adds the list of authorized nodes to acelive-файл список авторизованных узлов file (в данном случае это источникin this case, it's the source: 192.168.1.1).

После запуска трансляции в папке After broadcast's launch a file test.acelive will be created in directory /home/www/streams будет создан файл test.acelive, в папке in directory <tt>/tmp/streams</tt> будут созданы такие файлыsuch files will be created:*<tt>test</tt> - кэш трансляцииbroadcast cache. Размер этого файла примерно равен длительность_потока_в_секундах This file's size is approximately equal to stream_duration_in_seconds (опция <tt>--duration</tt>option, по умолчанию by default: 1 часhour) * битрейт байтbitrate byte*<tt>test.restart</tt> - здесь хранится информация для корректного перезапуска трансляцииinformation for correct restart of broadcast is kept here*<tt>test.sauth</tt> - ключ для цифровой подписи трансляцииkey for a broadcast's digital signature

Для просмотра трансляции клиенты могут скачать файл трансляции по ссылке To watch broadcasts clients can download broadcast file at <tt><nowiki>http://192.168.1.1/streams/test.acelive</nowiki></tt> и запустить его в плеере and start it in ACE Stream, либо использовать другие способы player or use other ways ([[Способы просмотра трансляцииWays to watch broadcasts]]).

====Источник с внешним трекеромSource with external tracker====Если трансляция предполагает большое количество пользователейIf broadcast involves a large number of users, то желательно использовать внешний трекер и отключить встроенный it's better to use external tracker and disable embedded one (для снижения нагрузки на источникto reduce burden on the source).

В качестве внешнего трекера мы советуем использовать We recommed to use [http://xbtt.sourceforge.net/tracker/ XBT Tracker]as external tracker.

В данном примере предполагаем, что In this example we assume that XBT Tracker установлен и запущен на сервере is installed and launched on server 192.168.1.1.Запуск трансляции теперь будет выглядеть таким образомNow broadcast's launch will look like: <tt>acestreamengine--stream -source \

--title "Тестовая трансляцияTest broadcast" \

--tracker "udp://192.168.1.1:2710/announce" \</tt> <tt> --skip-internal-tracker</tmp/testtt> option disconnects embedded tracker, <tt>--source.log 2>&1tracker</tt>option connects external tracker.

Опция <tt>--skip-internal-tracker</tt> отключает встроенный трекер====Source with two support nodes====If there is not enough upstream bandwidth for normal work of broadcast on the source, опция <tt>--tracker</tt> подключает внешний трекерsupport nodes can be used. Support node is often a node that receives data from the source and gives to clients (though support node can also receive data from other support nodes and even clients, depending on its settings). It makes sense to install support node on a separate server with a good width of output channel.

Для максимально эффективной работы схемы с узлами поддержки источнику необходимо сообщить адреса этих узлов с помощью опции <tt>--support-node</tt>: <tt>acestreamengine--stream -source \

--title "Тестовая трансляцияTest broadcast" \

--support-node "192.168.1.3:8621" \ > /tmp/test-source.log 2>&1</tt>

Запускаем узлы поддержки на серверах Launch support nodes on servers 192.168.1.2 и and 192.168.1.3 (команды для запуска одинаковыеcommands are the same): <tt>acestreamengine--stream-node \

--allow-source-download \ > /tmp/test-node.log 2>&1</tt>

Опция Option <tt>--source-node</tt> задает адрес источникаsets source address.

Опция Option <tt>--allow-source-download</tt> разрешает узлу поддержки скачивать данные с источника allows support node to download data from the source (скачивание с других узлов поддержки и клиентов в данном случае запрещеноdownloading from other support nodes and clients in this case is forbidden).

Если необходимо разрешить узлам поддержки скачивать данные с других узлов поддержкиTo allow support nodes to download data from other suppport nodes, то следует задать список других узлов опцией you should set a list of other nodes using <tt>--support-node</tt> и разрешить скачивание опцией option and allow downloading using <tt>--allow-support-download</tt>option.

На сервере On server 192.168.1.2 это будет выглядеть такit will look like: <tt>acestreamengine--stream-node \

--allow-support-download \ > /tmp/test-node.log 2>&1</tt>

На сервере On server 192.168.1.3: <tt>acestreamengine--stream-node \

--allow-support-download \ > /tmp/test-node.log 2>&1</tt>

====Приватный источник с двумя узлами поддержкиPrivate source with two support nodes====Иногда может возникнуть необходимость запретить клиентам напрямую обращаться к источнику трансляцииSometimes it may be necessary to prevent clients from direct access to broadcast source. НапримерFor example, источник может быть физически расположен на сервере в защищенной зоне без доступа из внешнего мираthe source may be located on server in protected area without access from the outer world. В этом случае трансляцию можно организовать по следующей схемеIn this case broadcast can be organized by the following scheme:*источник делается приватным the source is made private (получать от него данные смогут только узлы поддержкиonly support nodes, указанные явным образомspecified explicitly, can receive data from it)*узлы поддержки получают данные от источника и отдают клиентамsupport nodes receive data from the source and give to clients*клиенты получают данные от узлов поддержкиclients receive data from support nodes

Для того, чтобы сделать источник приватнымTo make the source private, следует указать опцию option <tt>--private-source</tt>must be specified: <tt>acestreamengine--stream -source \

--title "Тестовая трансляцияTest broadcast" \

--private-source \ > /tmp/test-source.log 2>&1</tt>

Следует обратить внимание на то, что в данной конфигурации адрес трекера изменен на Notice that in this configuration tracker's address is changed to <tt>udp://192.168.1.2:2710/announce</tt>. Это сделано для поддержки старых версий клиентовIt was made to support old versions of clients, которые не обрабатывают список авторизованных пиров which do not process a list of authorized peers (подробнее здесь more details here [[#Авторизованные узлыAuthorized peers|Авторизованные узлыAuthorized peers]]).

Узлы поддержки на серверах Launch support nodes on servers 192.168.1.2 и and 192.168.1.3 запускаем как обычноas usual: <tt>acestreamengine--stream-node \

--allow-source-download \ > /tmp/test-node.log 2>&1</tt>