]> git.ipfire.org Git - thirdparty/tvheadend.git/commitdiff
mdhelp: clean up the access doc, update screenshots
authorMark Clarkstone <hello@markclarkstone.co.uk>
Fri, 16 Dec 2016 15:45:43 +0000 (15:45 +0000)
committerJaroslav Kysela <perex@perex.cz>
Fri, 16 Dec 2016 17:34:46 +0000 (18:34 +0100)
docs/class/access_entry.md
docs/property/change_parameters.md [new file with mode: 0644]
src/access.c
src/webui/static/img/doc/accessentriesgrid.png
src/webui/static/img/doc/accessentriesnewuser.png

index 933b3abf840bac5df51d8e88d12904a8a77a60dd..60535e877fd275f483eed30d6844f4ccc4b5246c 100644 (file)
@@ -3,20 +3,19 @@ is initially wide open**.
 
 Tvheadend verifies access by scanning through all enabled access control
 entries in sequence, from the top of the list to the bottom. The permission
-flags, streaming profiles, DVR config profiles, channel tags, channel
-number ranges are combined for all matching access entries if allowed using
-the change flag. If the parameter is empty (permission
-flags, all types of profiles, channel tags and ranges) in an access
-control entry and the parameter change flag is turned on,
-the parameter (value, list or range) is cleared (unset).
+flags, streaming profiles, DVR config profiles, channel tags, and channel
+number ranges are combined for all matching access entries. You can 
+control which parameters are merged (on a per-entry basis), see 
+*Change parameters* [below](#items) for details. 
 
-An access entry is said to match if the username matches and the IP
-source address of the requesting peer is within the prefix. There is also
-anonymous access, if the user is set to asterisk. Only network prefix is
-matched then.
+An access entry is said to match if the username and the IP source 
+address of the requesting peer is within the prefix (*Allowed networks*).
+Wildcard ([anonymous](#anonymous-access)) accounts are matched using the 
+prefix only.
 
-*The order of entries is really important!* It is recommended to put the
-wildcards on top of the entries and the special permissions to the bottom.
+*The order of entries is **extremely** important!* It's recommended 
+that you put the wildcard (asterisk `*`) accounts at top and all other 
+accounts (with special permissions) at the bottom.
 
 !['Access Entries Grid'](static/img/doc/accessentriesgrid.png)
 
@@ -40,12 +39,12 @@ Button                 | Function
 
 ####Example
 
-This is an example of a limited user account entry.
+This is an example of a limited user entry.
 
 !['Access Entry Example'](static/img/doc/accessentriesnewuser.png)
 
-Remember to also create a password entry for the user in the 
-*[Passwords](class/passwd)* tab!
+Remember to also add a password entry in the 
+*[Passwords](class/passwd)* tab - not required for wildcard accounts. 
 
 **Tips**:
 * Be as limiting as possible especially when making Tvheadend available 
diff --git a/docs/property/change_parameters.md b/docs/property/change_parameters.md
new file mode 100644 (file)
index 0000000..92ad2df
--- /dev/null
@@ -0,0 +1,29 @@
+:
+
+Allows you to control which parameters are merged. If the 
+*Change parameters* flag is turned on and a parameter 
+(permission flags, all types of profiles, channel tags and ranges)
+for an entry is not set the parameter (value, list or range) is cleared 
+(unset). This allows the previous/next matching entry in the sequence to set 
+it.
+
+For example, say you have a wildcard account with the theme set to Gray, 
+and an admin account with the Blue theme. Unchecking the theme checkbox 
+for the admin user would mean that the theme from the last matching 
+entry (which in this case would be the wildcard account) applies instead.
+
+Option                     | Description/Properties
+---------------------------|---------------------------
+**Rights**                 | *Streaming*, *Web interface*, *Video recorder* (DVR), *Admin* and *Anonymize HTSP access*.
+**Channel number range**   | *Minimal channel number* and *Maximal channel number*.
+**Channel tags**           | *Exclude channel tags* and *Channel tags*.
+**DVR configurations**     | *DVR configuration profiles*.
+**Streaming profiles**     | *Streaming profiles*.
+**Connection limits**      | *Connection limit type* and *Limit connections*.
+**Language**               | *Language*.
+**Web interface language** | *Web interface language*.
+**Theme**                  | *Theme*.
+**User interface level**   | *User interface level*.
+
+The above table displays the *Change parameters* option name and the fields that it 
+applies to, as shown in add/edit dialog(s).
index 2b668a46c5a461ad261e3c5e1f8a14abe6f3abd0..99c8b82eb743de20d1f03e18c2ff145fda63fd2a 100644 (file)
@@ -1418,7 +1418,7 @@ static idnode_slist_t access_entry_class_change_slist[] = {
   },
   {
     .id   = "change_chrange",
-    .name = N_("Channel range"),
+    .name = N_("Channel number range"),
     .off  = offsetof(access_entry_t, ae_change_chrange),
   },
   {
@@ -1591,6 +1591,7 @@ PROP_DOC(themes)
 PROP_DOC(connection_limit)
 PROP_DOC(persistent_viewlevel)
 PROP_DOC(streaming_profile)
+PROP_DOC(change_parameters)
 
 const idclass_t access_entry_class = {
   .ic_class      = "access",
@@ -1640,7 +1641,8 @@ const idclass_t access_entry_class = {
       .islist   = 1,
       .id       = "change",
       .name     = N_("Change parameters"),
-      .desc     = N_("Specify the parameters to be changed."),
+      .desc     = N_("Specify the parameters to be changed. See Help for details."),
+      .doc      = prop_doc_change_parameters,
       .list     = access_entry_class_change_enum,
       .get      = access_entry_class_change_get,
       .set      = access_entry_class_change_set,
@@ -1703,7 +1705,7 @@ const idclass_t access_entry_class = {
       .id       = "streaming",
       .name     = N_("Streaming"),
       .desc     = N_("Streaming flags, allow/disallow HTTP streaming, "
-                     "advanced HTTP streming (e.g, direct service or mux links), "
+                     "advanced HTTP streaming (e.g, direct service or mux links), "
                      "HTSP protocol streaming (e.g, Kodi (via pvr.hts) or Movian."),
       .list     = access_entry_class_streaming_enum,
       .get      = access_entry_class_streaming_get,
index 3ed7d2b27eb139aa7d27751f46beceef4caaf642..063f1ebc3bede3a3c855f9eb3741c329e13fa75d 100644 (file)
Binary files a/src/webui/static/img/doc/accessentriesgrid.png and b/src/webui/static/img/doc/accessentriesgrid.png differ
index 970c9e5bbdbfac2407799d82887d047283ab3e53..db938093e4e0530d99212811f7bb89434ebf4010 100644 (file)
Binary files a/src/webui/static/img/doc/accessentriesnewuser.png and b/src/webui/static/img/doc/accessentriesnewuser.png differ