From: Mark Clarkstone Date: Sat, 16 Apr 2016 03:22:54 +0000 (+0100) Subject: mdhelp: add some more tips to various docs mdhelp: add sections on how to add/edit... X-Git-Tag: v4.2.1~631 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=516f92311e6c526d006102625a5442507ebcc8b0;p=thirdparty%2Ftvheadend.git mdhelp: add some more tips to various docs mdhelp: add sections on how to add/edit/delete password entries to passwd doc mdhelp: add dialog screenie (configpasswdadd.png) --- diff --git a/docs/class/access_entry.md b/docs/class/access_entry.md index fc1d43d3b..cd657be29 100644 --- a/docs/class/access_entry.md +++ b/docs/class/access_entry.md @@ -45,14 +45,14 @@ apply to subsequent accounts.** !['Access Entry Example'](docresources/accessentriesnewuser.png) **Don't forget** to also create a password entry for the user in the -*Passwords* tab! +*[Passwords](class/passwd)* tab! **Tips**: * Be as limiting as possible especially when making Tvheadend available over the internet. * For extra security, always enter (a comma-separated list of) network prefix(es) (*Allowed networks* in the *Add Access Entry* dialog). * If you lock yourself out, you can use the backdoor account to regain access, or restart Tvheadend with the `--noacl` argument. * You can have multiple entries using the same username with varying rights, allowing you to enable / disable each as needed. Keep in mind that matching account entry permissions are combined. - +* If you do create an anonymous account, it also requires a [password](class/passwd) entry (enter an asterisk `*` for both the username and password fields when adding the entry). --- ### Editing an Entry/Account @@ -66,8 +66,12 @@ page for details. --- -### Deleting a User. +### Deleting an Entry/Account. To delete a user highlight (select) the entry from the grid, then press the *[Delete]* button from the menu bar. +**Tip**: Rather than deleting an entry, you can disable it instead by +pressing the *[Edit]* button, and unticking the "Enabled" check box. + +--- diff --git a/docs/class/passwd.md b/docs/class/passwd.md index 0d7858b77..8d0edd8a7 100644 --- a/docs/class/passwd.md +++ b/docs/class/passwd.md @@ -1,11 +1,10 @@ This tab is the second part of Tvheadend's access control mechanism. It is where you set and maintain all user passwords (e.g. for streaming or DVR access). -One user name might have multiple passwords. - !['Configuration - Passwords tab'](docresources/configpasswordentries.png) --- + ###Buttons The tab has the following buttons: @@ -20,3 +19,32 @@ Button | Function **Help** | Display this help page. --- + +###Adding and Editing an Entry/Password + +To add an entry press the *[Add]* button from the menu bar. To edit an +entry highlight (select) the entry from the grid, then press the +*[Edit]* button from the menu bar. Be aware that the username you enter +must match a username/entry in the [Access Entries](class/access_entry) +tab for it to apply. You may have multiple password entries for the +same username if you wish. + +!['Add Password dialog'](docresources/configpasswdadd.png) + +Note that both the *[Add]* and *[Edit]* buttons display similar dialogs. + +**Tip**: You can quickly make changes to an entry by double-clicking on +the desired field within the grid. See *Editing Fields* on the [Web interface Guide - General](webui_general) +page for details. + +--- + +### Deleting an Entry. + +To delete an password entry highlight (select) the entry from the grid, then press +the *[Delete]* button from the menu bar. + +**Tip**: Rather than deleting an entry, you can disable it instead by +pressing the *[Edit]* button, and unticking the "Enabled" check box. + +--- diff --git a/docs/docresources/configpasswdadd.png b/docs/docresources/configpasswdadd.png new file mode 100644 index 000000000..bb4093fe4 Binary files /dev/null and b/docs/docresources/configpasswdadd.png differ