379
edits
Changes
→Syntax of acestreamengine --stream-source command
Repository should be selected according to operating system.
''Debian 6+:''
<tt><nowiki>deb http://repo.acestream.org/debian/ squeeze main</nowiki></tt>
or
Note: packages in sid repository are assembled with dependencies that correspond to official sid-repositories of Debian.
If you don't know, which repository to choose, use squeeze.
''Debian 7:''
<tt><nowiki>deb http://repo.acestream.org/debian/ wheezy main</nowiki></tt>
''Ubuntu 11.10:''
''Ubuntu 12.10:''
<tt><nowiki>deb http://repo.acestream.org/ubuntu/ quantal main</nowiki></tt>
''Ubuntu 13.04:''
<tt><nowiki>deb http://repo.acestream.org/ubuntu/ raring main</nowiki></tt>
'''Step 2'''
For Debian only the engine (acestream-engine) is available.
<!--
=== Installing ACE Stream package on Ubuntu from deb-package ===
You can install ACE Stream on Ubuntu without using repository. To do this you need to download the installation package by one of links below and install it using a package manager (for example, by double click on downloaded package).
This intallation package is an analog of <tt>acestream-full</tt> package from repository. It includes the engine, player and plug-in for browsers.
-->
=== Installing Ace Stream on the CentOS ===
Requirements:
* installed python 2.6
* installed module python-argparse
To install Ace Stream on CentOS you need:
* download an archive that corresponds to your CentOS version (links are below)
* extract files from archive and copy contents to /usr dir
The following packages are available at this moment:
*'''CentOS 5 64bit''': http://dl.acestream.org/centos/5/acestream-engine-2.1.6_4-centos5-x86_64.tar.gz
*'''CentOS 6 64bit''': http://dl.acestream.org/centos/6/acestream-engine-2.1.6_4-centos6-x86_64.tar.gz
This package was tested on CentOS 5.8 and 6.3.
==Launching broadcast==
===Main terms===
*'''Source''' - a program that accepts broadcast's HTTP-stream of broadcast and provides playback of broadcast viewing using ACE Stream software.*'''Support node''' - a program allowing to scale broadcast using additional server equipment and Internet-channels.
*'''Client''' - ACE Stream software, which is used to play broadcast.
===Transition from versions 2.0.х to version 2.1 and higher===
From September, 10, 2013, upgraded version of the engine (2.1.6) for Ubuntu, Debian and CentOS is available.
Before using a new version for production, we recommend to test it on one or several broadcasts, if possible.
If you face any problems, please, write to the forum (http://forum.torrentstream.org) or email support@acestream.net.
Old versions are temporarily available in repository and by direct links:
'''Ubuntu''':
* http://dl.acestream.org/ubuntu/acestream-engine_2.0.8-1oneiric6_amd64.deb
* http://dl.acestream.org/ubuntu/acestream-engine_2.0.8-1oneiric6_i386.deb
* http://dl.acestream.org/ubuntu/acestream-engine_2.0.8-1precise6_amd64.deb
* http://dl.acestream.org/ubuntu/acestream-engine_2.0.8-1precise6_i386.deb
* http://dl.acestream.org/ubuntu/acestream-engine_2.0.8-1quantal6_amd64.deb
* http://dl.acestream.org/ubuntu/acestream-engine_2.0.8-1quantal6_i386.deb
* http://dl.acestream.org/ubuntu/acestream-engine_2.0.8-1raring6_amd64.deb
* http://dl.acestream.org/ubuntu/acestream-engine_2.0.8-1raring6_i386.deb
'''Debian''':
* http://dl.acestream.org/debian/acestream-engine_2.0.8-1sid5_amd64.deb
* http://dl.acestream.org/debian/acestream-engine_2.0.8-1sid5_i386.deb
* http://dl.acestream.org/debian/acestream-engine_2.0.8-1squeeze5_amd64.deb
* http://dl.acestream.org/debian/acestream-engine_2.0.8-1squeeze5_i386.deb
'''CentOS 6''':
* http://dl.acestream.org/centos/6/acestream-engine-2.0.8_7-centos6-x86_64.tar.gz
<span style="color: #900;">ATTENTION!</span> In the nearest future support for older versions will be stopped.
<span style="color: #009;">IMPORTANT!</span> All broadcasts created via new version of Ace Stream (2.1 and higher) are not suppported by client software of old versions (2.0.х and lower). If you attempt to watch a new broadcast using the old engine, an error "Cannot load transport file" will appear.
====Changes in launch parameters====
Some parameters of the launch of sources and support nodes from the command line have been changed, therefore the launch with the old command line will not work.
Main changes:
* one executable file is used <tt>acestreamengine</tt>; different launch modes (a source, support node) are set by options:
** instead of <tt>acestreamengine-stream</tt> you should launch <tt>acestreamengine --stream-source</tt>
** instead of <tt>acestreamengine-node</tt> you should launch <tt>acestreamengine --stream-node</tt>
** instead of <tt>acestreamengine-client-console</tt> you should launch <tt>acestreamengine --client-console</tt>
** instead of <tt>acestreamengine-client-gtk</tt> you should launch <tt>acestreamengine --client-gtk</tt>
* log system is changed. In old versions the engine output all debug information into STDERR and redirecting the output was required to write logs into a file. In a new version it is possible to define in options, where to write logs - into STDOUT, into STDERR, into a file or syslog. Rotation of logs by their size is supported for files. You can read description of all options in [[#acestreamengine command|acestreamengine command]]
===acestreamengine command===
Starting from version 2.1 Ace Stream Engine for Linux represents a single executable file <tt>acestreamengine</tt>, which works in different modes, depending on specified parameters.
Work mode is set by one of the following parameters:
* <tt>--client-console</tt> - launch engine in a client mode from console (without a graphic interface)
* <tt>--client-wx</tt> - launch engine in a client mode with a graphic interface WX
* <tt>--client-gtk</tt> - launch engine in a client mode with a graphic interface GTK
* <tt>--stream-source</tt> - launch a source of broadcast
* <tt>--stream-node</tt> - launch a support node
* <tt>--create-transport</tt> - create a transport file from existing content (VOD)
* <tt>--create-transport-multi</tt> - create a multi-stream transport file
* <tt>--version</tt> - show engine version
Each work mode has their own required and not required parameters, described in appropriate sections.
Also all work modes have common parameters that manage the output of debug information.
* <tt>--log-stdout</tt> - deduce information in STDOUT
* <tt>--log-stderr</tt> - deduce information in STDERR
* <tt>--log-file PATH</tt> - deduce information in a specified file
* <tt>--log-max-size SIZE</tt> - maximum file size (bytes)
* <tt>--log-backup-count COUNT</tt> - how many backup logs have to be stored (backup log file is created when a limit, specified by a parameter --log-max-size, is reached)
* <tt>--log-file-buffer SIZE</tt> - enable buffering of output into the file (using buffer of specified size in bytes)
* <tt>--log-syslog HOST</tt> - deduce information in syslog-server at the specified address
* <tt>--log-syslog-port PORT</tt> - syslog-server port
* <tt>--log-syslog-facility FACILITY</tt> - used facility
* <tt>--log-syslog-buffer SIZE</tt> - enable buffering of output into syslog (using buffer of specified size in bytes)
===Common work scheme ===
The source accepts HTTP-stream to input (at this moment HTTP-streams with MPEG-TS encapsulation are supported) with original 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>--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>--showlog-piecesdebug DEBUG</tt> - show 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 log numbers 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 pieces 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>--sid</tt> - content identificator for statistics(for an affiliate program)*<tt>--permanent</tt> - mark the broadcast as they are created24/7 (it's available all the time)*<tt>--date-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>--showmax-peers</tt> - periodically show in log list limit number of connected connections to other peers(default is 50)*<tt>--service-remote-access</tt> - enable remote statistics*<tt>--service-access-token</tt> - password for remote statistics access*<tt>--stats-report-interval</tt> - interval in seconds between internal statistics update (default is 60)*<tt>--debug DEBUGstats-report-peers</tt> - set debug levelupdate information about connected peers in the internal statistics (increases CPU load)
''additional''
*<tt>-h, --help</tt> - show commands' description
=== Syntax of acestreamengine--stream-node command===<tt>acestreamengine--stream-node</tt> command launches support node.
''required parameters''
*<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> - maximum limit number of incoming total connections (from other peers) (by default: is 1000)*<tt>--max-outgoing-connects MAX_OUTGOING_CONNECTSpeers MAX_PEERS</tt> - maximum limit number of outgoing connections (to other peers) (by 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-piecesdebug DEBUG</tt> -show in set the debug level (default is 0 - minimum log numbers of pieces as they are createdlevel)*<tt>--service-remote-access</tt> - enable remote statistics*<tt>--showservice-peersaccess-token</tt> - periodically show in log list of connected peers password for remote statistics access*<tt>--stats-report-interval STATS_REPORT_INTERVAL</tt> - set interval in seconds to show in log information about download/upload speep. By between internal statistics update (default: 0 (do not showis 60).*<tt>--debug DEBUGstats-report-peers</tt> - set debug levelupdate information about connected peers in the internal statistics (increases CPU load)
''additional''
We launch the source on server 192.168.1.1:
<tt>acestreamengine--stream -source \
--name "test" \
--title "Test broadcast" \
--publish-dir "/home/www/streams" \
--cache-dir "/tmp/streams" \
--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> shows outputs all debug information in console in STDERRthe 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).
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 \
--name "test" \
--title "Test broadcast" \
--add-authorized-peers \
--skip-internal-tracker \
--tracker "udp://192.168.1.1:2710/announce" \ > /tmp/test-source.log 2>&1</tt>
<tt>--skip-internal-tracker</tt> option disconnects embedded tracker, <tt>--tracker</tt> option connects external tracker.
====Источник с двумя узлами поддержкиSource with two support nodes====В случаеIf there is not enough upstream bandwidth for normal work of broadcast on the source, если на источнике не хватает пропускной способности исходящего канала для нормальной работы трансляции, можно использовать узлы поддержки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. To make a scheme with support nodes work with maximum efficiency, addresses of these nodes must be given to the sourceusing <tt>--support-node</tt> option:
--name "test" \
--title "Тестовая трансляцияTest broadcast" \
--source "<nowiki>http://192.168.1.100/stream</nowiki>" \
--bitrate 300000 \
--tracker "udp://192.168.1.1:2710/announce" \
--support-node "192.168.1.2:8621" \
--support-node "192.168.1.3:8621" \ > /tmp/test-source.log 2>&1</tt>
--url "<nowiki>http://192.168.1.1/streams/test.acelive</nowiki>" \
--state-dir "/tmp" \
--source-node "192.168.1.1:7764" \
--allow-source-download \ > /tmp/test-node.log 2>&1</tt>
--url "<nowiki>http://192.168.1.1/streams/test.acelive</nowiki>" \
--state-dir "/tmp" \
--allow-source-download \
--support-node "192.168.1.3:8621" \
--allow-support-download \ > /tmp/test-node.log 2>&1</tt>
--url "<nowiki>http://192.168.1.1/streams/test.acelive</nowiki>" \
--state-dir "/tmp" \
--allow-source-download \
--support-node "192.168.1.2:8621" \
--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
--name "test" \
--title "Тестовая трансляцияTest broadcast" \
--source "<nowiki>http://192.168.1.100/stream</nowiki>" \
--bitrate 300000 \
--support-node "192.168.1.2:8621" \
--support-node "192.168.1.3:8621" \
--private-source \ > /tmp/test-source.log 2>&1</tt>
--url "<nowiki>http://192.168.1.1/streams/test.acelive</nowiki>" \
--state-dir "/tmp" \
--source-node "192.168.1.1:7764" \
--allow-source-download \ > /tmp/test-node.log 2>&1</tt>
