]> git.ipfire.org Git - thirdparty/tvheadend.git/commitdiff
docs: update and add persistent auth info, refresh some screenshots and tweak a few...
authorMark Clarkstone <hello@markclarkstone.co.uk>
Thu, 8 Nov 2018 18:07:25 +0000 (18:07 +0000)
committerJaroslav Kysela <perex@perex.cz>
Tue, 27 Nov 2018 13:35:41 +0000 (14:35 +0100)
14 files changed:
docs/markdown/status_connections.md
docs/markdown/status_stream.md
docs/markdown/status_subscriptions.md
docs/property/auth.md [new file with mode: 0644]
docs/property/authcode.md [new file with mode: 0644]
src/access.c
src/webui/static/img/doc/epg/autorec.png
src/webui/static/img/doc/epg/series_link.png
src/webui/static/img/doc/epg/tab.png
src/webui/static/img/doc/status/connections.png
src/webui/static/img/doc/status/stream.png
src/webui/static/img/doc/status/subscriptions.png
src/webui/static/img/doc/users/add_password.png
src/webui/static/img/doc/users/passwords_tab.png

index f5e27108499594e3c6a2767704ff66e5dec54032..2a356870f6a066102b535fff1a26f707d0f3d336 100644 (file)
@@ -28,11 +28,26 @@ This is a read-only tab; nothing is configurable.
 **Type**
 : Connection type - HTSP or HTTP.
 
-**IP Address**
-: The IP address of the device. 
+**Client Address**
+: The IP address of the client device.
+
+**Client Port**
+: The port of the client device.
+
+**Client Data Ports**
+: The data port(s) used by the client device.
 
 **Username**
 : The username used to access tvheadend (a blank cell indicates no username was supplied).
 
 **Started**
 : Date the connection started - YYYY-MM-DD HH:MM:SS.
+
+**Streaming**
+: The number of active streams.
+
+**Server Address**
+: The address used to connect to the server. This is usually the IP of your device running Tvheadend.
+
+**Proxy Address**
+: The IP address of the proxy the client is connecting through (if known).
index 63ebd76caea1a78654958a5e9ad73f775d261e92..81a5876e75a76b9e530bb778fc50bb776b4ad227 100644 (file)
@@ -23,7 +23,7 @@ This is a read-only tab; nothing is configurable.
 ## Items
 
 **Sweep/Clean Icon !['Status - Stream' Tab](static/icons/clean.png)**
-: Clear all "Uncorrected Blocks", "BER", etc stats. 
+: Clear all "Uncorrected Blocks", "BER", etc stats.
 
 **Input**
 : Device used to receive the stream.
@@ -32,7 +32,10 @@ This is a read-only tab; nothing is configurable.
 : Number of subscriptions using the stream.
 
 **Weight**
-: Stream weighting. 
+: Stream weighting.
+
+**PID list**
+: Input source Program Identification (PIDs) numbers in use.
 
 **Bandwidth**
 : Total stream input bandwidth.
@@ -44,23 +47,23 @@ This is a read-only tab; nothing is configurable.
 : [Packet Error Ratio](https://en.wikipedia.org/wiki/Bit_error_rate#Packet_error_ratio)
 
 **Uncorrected Blocks**
-: Number of uncorrected blocks. A value higher than 0 can indicate a 
+: Number of uncorrected blocks. A value higher than 0 can indicate a
 weak signal or interference, note that some devices can send a false value.
 
 **Transport Errors**
-: Number of transport streams errors. A fast increasing value here can 
-indicate signal issues. Device drivers can sometimes send garbage data at 
-the beginning of a stream, as long as the value doesn't increase at a fast 
+: Number of transport streams errors. A fast increasing value here can
+indicate signal issues. Device drivers can sometimes send garbage data at
+the beginning of a stream, as long as the value doesn't increase at a fast
 pace and you have no playback issues, there is nothing to worry about.
 
 **Continuity Errors**
 : Continuity Count Error. Number of stream errors, a high value here can indicate a signal problem.
 
 **SNR**
-: Signal (To) Noise Ratio. [The level of a desired signal to the level of background noise](https://en.wikipedia.org/wiki/Signal-to-noise_ratio), 
-note that not all devices supply correct signal information, 
+: Signal (To) Noise Ratio. [The level of a desired signal to the level of background noise](https://en.wikipedia.org/wiki/Signal-to-noise_ratio),
+note that not all devices supply correct signal information,
 the value here can sometimes be ambiguous.
 
 **Signal Strength**
-: The signal strength as reported by the device, note that not all devices 
+: The signal strength as reported by the device, note that not all devices
 supply correct signal information, the value here can sometimes be ambiguous
index c3a37ecf0157a353c5b9c00d4d2a638c6d3e2e6d..9ce9c677dd00073b9e057a3d31f72aca5e6964a4 100644 (file)
@@ -29,18 +29,21 @@ This is a read-only tab; nothing is configurable.
 : Hostname/IP address using the subscription.
 
 **Username**
-: Username using the subscription - a blank cell indicates the 
+: Username using the subscription - a blank cell indicates the
 subscriber didn't supply a username.
 
 **Title**
-: Title of the application using the subscription - you will sometimes 
-see "epggrab" here, this is an internal subscription used by tvheadend 
+: Title of the application using the subscription - you will sometimes
+see "epggrab" here, this is an internal subscription used by Tvheadend
 to grab EPG data.
 
 **Channel**
-: The name of the [channel](class/channel) the subscription is using - 
+: The name of the [channel](class/channel) the subscription is using -
 if the subscription is streaming a service/mux this cell will be blank.
 
+**Service**
+: The service used by the subscription.
+
 **Profile**
 : The name of the [profile](class/profile) the subscription is using.
 
@@ -56,6 +59,9 @@ Running       | The subscription is active - the stream is being sent.
 Idle          | The subscription is idling, waiting for the subscriber.
 Testing       | Tvheadend is testing the requested stream to see if it's available - if a subscription stays in this state too long it may indicate a signal issue.
 
+**PID list**
+: Input source Program Identification (PIDs) numbers in use by the subscription.
+
 **Descramble**
 : The CAID used to descramble the stream.
 
diff --git a/docs/property/auth.md b/docs/property/auth.md
new file mode 100644 (file)
index 0000000..b89c3d9
--- /dev/null
@@ -0,0 +1,6 @@
+:
+
+Option      | Description
+------------|-------------
+Enable      | Enable persistent authentication.
+Reset       | Revoke the code and generate a new one. 
diff --git a/docs/property/authcode.md b/docs/property/authcode.md
new file mode 100644 (file)
index 0000000..e5f322a
--- /dev/null
@@ -0,0 +1,7 @@
+This code may be used instead of/along side the password to access playlists/streams.
+
+Method                                     | Example
+-------------------------------------------|------------------------------------
+HTTP authentication (digest/plain)         | ```http://ip:9981/playlist/auth``` or ```http://user:pass@ip:9981/playlist/auth```
+Authcode only                              | ```http://ip:9981/playlist/auth?auth={authcode}```
+Channel 'play' streams                     | ```http://ip:9981/play/stream/channelname/CHANNELNAME?auth={authcode}```
index c4d8030b6c2f25bd3dcf14144a91c338bdbfc943..96bc3616d5ff481f8d8368a4722e2d1adcae891b 100644 (file)
@@ -2181,6 +2181,8 @@ passwd_entry_class_auth_set ( void *obj, const void *p )
 }
 
 CLASS_DOC(passwd)
+PROP_DOC(auth)
+PROP_DOC(authcode)
 
 const idclass_t passwd_entry_class = {
   .ic_class      = "passwd",
@@ -2231,6 +2233,7 @@ const idclass_t passwd_entry_class = {
       .id       = "auth",
       .name     = N_("Persistent authentication"),
       .desc     = N_("Manage persistent authentication for HTTP streaming."),
+      .doc      = prop_doc_auth,
       .list     = passwd_entry_class_auth_enum,
       .get      = passwd_entry_class_auth_get,
       .set      = passwd_entry_class_auth_set,
@@ -2241,7 +2244,8 @@ const idclass_t passwd_entry_class = {
       .type     = PT_STR,
       .id       = "authcode",
       .name     = N_("Persistent authentication code"),
-      .desc     = N_("The code which may be used for the HTTP streaming."),
+      .desc     = N_("The code which may be used for HTTP streaming."),
+      .doc      = prop_doc_authcode,
       .off      = offsetof(passwd_entry_t, pw_auth),
       .opts     = PO_RDONLY,
     },
index 835c1b35d4c5c23d6a5eb875d5b450cf02c9f9c7..6e704bfe7611d9af27e3a990346862da8663da67 100644 (file)
Binary files a/src/webui/static/img/doc/epg/autorec.png and b/src/webui/static/img/doc/epg/autorec.png differ
index 7c4094179a20c2db5d4953a32ce14b64c9f580f6..97841a4f23ef0067b73afa98db22af64dbfc9272 100644 (file)
Binary files a/src/webui/static/img/doc/epg/series_link.png and b/src/webui/static/img/doc/epg/series_link.png differ
index 9352e600ff04554f1aa24ed793ce0e879d7c93fc..bb7f89d0efce96552ee493bbd02bde05b97211ce 100644 (file)
Binary files a/src/webui/static/img/doc/epg/tab.png and b/src/webui/static/img/doc/epg/tab.png differ
index f959cc5ca76711f972e8e9c7d7f118d36d5226e2..897739db264a24186ff55c886445a7e0d7e3cf9f 100644 (file)
Binary files a/src/webui/static/img/doc/status/connections.png and b/src/webui/static/img/doc/status/connections.png differ
index db483fb7222ce97c13654339efb193aae40a9006..af9e8c006b1d2466b94f389fe0d70e39e35cdf50 100644 (file)
Binary files a/src/webui/static/img/doc/status/stream.png and b/src/webui/static/img/doc/status/stream.png differ
index 2a007a4eaeeb5867d525cea984eea9b89c4ff287..f1d4ed87665466b9afe995506b437c624da48646 100644 (file)
Binary files a/src/webui/static/img/doc/status/subscriptions.png and b/src/webui/static/img/doc/status/subscriptions.png differ
index bb4093fe462c44dac218b7865e8c7aaf88ff44d1..379d96119e4e56101f13a8869e27517121c7a7ff 100644 (file)
Binary files a/src/webui/static/img/doc/users/add_password.png and b/src/webui/static/img/doc/users/add_password.png differ
index 0833bdc34996d58cea34da8fc09fd67dec932c9d..11c6148742a2b6ef09ed3dc0b5eeb21fccded960 100644 (file)
Binary files a/src/webui/static/img/doc/users/passwords_tab.png and b/src/webui/static/img/doc/users/passwords_tab.png differ