From: Mark Clarkstone Date: Thu, 8 Nov 2018 18:07:25 +0000 (+0000) Subject: docs: update and add persistent auth info, refresh some screenshots and tweak a few... X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7a9b164937ffa8599b9216fa9888cdbcc1cb66d6;p=thirdparty%2Ftvheadend.git docs: update and add persistent auth info, refresh some screenshots and tweak a few bits --- diff --git a/docs/markdown/status_connections.md b/docs/markdown/status_connections.md index f5e271084..2a356870f 100644 --- a/docs/markdown/status_connections.md +++ b/docs/markdown/status_connections.md @@ -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). diff --git a/docs/markdown/status_stream.md b/docs/markdown/status_stream.md index 63ebd76ca..81a5876e7 100644 --- a/docs/markdown/status_stream.md +++ b/docs/markdown/status_stream.md @@ -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 diff --git a/docs/markdown/status_subscriptions.md b/docs/markdown/status_subscriptions.md index c3a37ecf0..9ce9c677d 100644 --- a/docs/markdown/status_subscriptions.md +++ b/docs/markdown/status_subscriptions.md @@ -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 index 000000000..b89c3d923 --- /dev/null +++ b/docs/property/auth.md @@ -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 index 000000000..e5f322a90 --- /dev/null +++ b/docs/property/authcode.md @@ -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}``` diff --git a/src/access.c b/src/access.c index c4d8030b6..96bc3616d 100644 --- a/src/access.c +++ b/src/access.c @@ -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, }, diff --git a/src/webui/static/img/doc/epg/autorec.png b/src/webui/static/img/doc/epg/autorec.png index 835c1b35d..6e704bfe7 100644 Binary files a/src/webui/static/img/doc/epg/autorec.png and b/src/webui/static/img/doc/epg/autorec.png differ diff --git a/src/webui/static/img/doc/epg/series_link.png b/src/webui/static/img/doc/epg/series_link.png index 7c4094179..97841a4f2 100644 Binary files a/src/webui/static/img/doc/epg/series_link.png and b/src/webui/static/img/doc/epg/series_link.png differ diff --git a/src/webui/static/img/doc/epg/tab.png b/src/webui/static/img/doc/epg/tab.png index 9352e600f..bb7f89d0e 100644 Binary files a/src/webui/static/img/doc/epg/tab.png and b/src/webui/static/img/doc/epg/tab.png differ diff --git a/src/webui/static/img/doc/status/connections.png b/src/webui/static/img/doc/status/connections.png index f959cc5ca..897739db2 100644 Binary files a/src/webui/static/img/doc/status/connections.png and b/src/webui/static/img/doc/status/connections.png differ diff --git a/src/webui/static/img/doc/status/stream.png b/src/webui/static/img/doc/status/stream.png index db483fb72..af9e8c006 100644 Binary files a/src/webui/static/img/doc/status/stream.png and b/src/webui/static/img/doc/status/stream.png differ diff --git a/src/webui/static/img/doc/status/subscriptions.png b/src/webui/static/img/doc/status/subscriptions.png index 2a007a4ea..f1d4ed876 100644 Binary files a/src/webui/static/img/doc/status/subscriptions.png and b/src/webui/static/img/doc/status/subscriptions.png differ diff --git a/src/webui/static/img/doc/users/add_password.png b/src/webui/static/img/doc/users/add_password.png index bb4093fe4..379d96119 100644 Binary files a/src/webui/static/img/doc/users/add_password.png and b/src/webui/static/img/doc/users/add_password.png differ diff --git a/src/webui/static/img/doc/users/passwords_tab.png b/src/webui/static/img/doc/users/passwords_tab.png index 0833bdc34..11c614874 100644 Binary files a/src/webui/static/img/doc/users/passwords_tab.png and b/src/webui/static/img/doc/users/passwords_tab.png differ