From: Mark Clarkstone <hello@markclarkstone.co.uk>
Date: Sat, 24 Sep 2016 13:05:06 +0000 (+0100)
Subject: mdhelp: add a basic sat>ip server setup guide.
X-Git-Tag: v4.2.1~233
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=96907734da768c118721d73b28471b3c3e6d53a6;p=thirdparty%2Ftvheadend.git

mdhelp: add a basic sat>ip server setup guide.
---

diff --git a/docs/class/satip_server.md b/docs/class/satip_server.md
index 7fa9fcc7e..5e9b343f7 100644
--- a/docs/class/satip_server.md
+++ b/docs/class/satip_server.md
@@ -1,17 +1,7 @@
-SAT>IP Server is something like DVB network tuner. Tvheadend can
+SAT\>IP Server is something like DVB network tuner. Tvheadend can
 forward mpegts input streams including on-the-fly descramling to SAT\>IP
 clients.
 
-Only networks with the “SAT>IP Source” field set are exported through
-the SAT>IP protocol. This field is matched through the “src” parameter
-requested by the SAT>IP client. Usually (and by default) this value is 1.
-For satellite tuners, this value determines the satellite source (dish).
-By specification position 1 = DiseqC AA, 2 = DiseqC AB, 3 = DiseqC BA, 4
-= DiseqC BB, but any numbers may be used - depends on the SAT\>IP
-client. Note that if you use a similar number for multiple networks, the
-first matched network containing the mux with requested parameters will
-win (also for unknown mux).
-
 !['SAT\>IP Config tab'](static/img/doc/satipconfig.png)
 
 ---
@@ -28,3 +18,50 @@ Button                      | Function
 <tvh_include>inc/common_button_table_end</tvh_include>
 
 ---
+
+###General Information
+
+Only networks with the “SAT>IP Source” field set are exported through 
+the SAT>IP protocol. This field is matched through the “src” parameter 
+requested by the SAT>IP client. Usually (and by default) this value 
+is 1. For satellite tuners, this value determines the satellite source 
+(dish). By specification position 1 = DiseqC AA, 2 = DiseqC AB, 3 = 
+DiseqC BA, 4 = DiseqC BB, but any numbers may be used - depends on the 
+SAT>IP client. Note that if you use a similar number for multiple 
+networks, the first matched network containing the mux with requested 
+parameters will win (also applies to unknown muxes).
+
+---
+
+###Basic Configuration Guide
+
+####1. Define the RTSP Port
+
+This can be anything you like, however it is 
+recommended that you use 9983 (to avoid permission issues). Entering 
+zero (0) in this field will disable the server. 
+
+####2. Export the Tuners
+
+In the *Exported tuners* section enter the 
+number of tuners (per delivery system) that you'd like to export. This 
+setting lets the client know how many tuners are available for use. 
+While you can enter any number you like here, exporting more tuners 
+than you have can lead to scanning/tuning failures, e.g. "No free tuner".
+
+####3. Export Your Networks 
+
+Tvheadend won't export any tuners without any assigned networks, if you 
+haven't already done so you must enter a *SAT\>IP source number* for 
+a [network](mpegts_network). If you don't export a network you may see 
+the following debug error message.
+
+`satips: SAT>IP server announces an empty tuner list to a client <IP ADDRESS OF CLIENT> (missing network assignment)` 
+
+####4. Configure Your Client
+
+Hopefully (and if everything went to plan) your client should have 
+now detected Tvheadend as a SAT\>IP server, if not, you may want to 
+trigger service discovery or restart it.
+
+---