From 3e3cad14c39022f45d7824e16f62e96479c10cc1 Mon Sep 17 00:00:00 2001 From: Mark Clarkstone Date: Mon, 20 Jun 2016 18:43:37 +0100 Subject: [PATCH] mdhelp: clean-up and add superuser access info --- docs/class/access_entry.md | 35 +++++++++++++++++++++++--- docs/class/channel.md | 2 ++ docs/class/dvrentry.md | 10 ++++---- docs/class/mpegts_network.md | 10 ++++---- docs/markdown/inc/add_grid_entry.md | 11 ++++---- docs/markdown/inc/edit_grid_entries.md | 14 +++++------ 6 files changed, 56 insertions(+), 26 deletions(-) diff --git a/docs/class/access_entry.md b/docs/class/access_entry.md index dcb3c0672..89999faea 100644 --- a/docs/class/access_entry.md +++ b/docs/class/access_entry.md @@ -46,13 +46,13 @@ anonymous account also apply to subsequent accounts.** **Tips**: * Be as limiting as possible especially when making Tvheadend available over the Internet. -* For extra security, always enter (a comma-separated list of) +* For extra security always enter (a comma-separated list of) network prefix(es) (*Allowed networks*). -* If you lock yourself out, you can use the backdoor account to regain +* If you lock yourself out, you can use the [backdoor account](#emergency-backdoor-access) 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. +that matching account entry permissions are combined (enabled entries only). * If you 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). @@ -66,3 +66,32 @@ username and password fields when adding the entry). inc/del_grid_entries --- + +###Emergency/Backdoor Access + +Tvheadend includes functionality that allows you to regain access to +your Tvheadend instance in case of emergency or if you find yourself +locked out, this is known as a superuser account. On some systems you +might been asked to enter a superuser username and password during +installation. + +To create a superuser account you must have access to your Tvheadend +configuration directory (most commonly `$HOME/.hts/tvheadend`) and +be able to create a plain-text file named `superuser` with the following +(JSON formatted) content: + +``` +{ +"username": "superuser", +"password": "superpassword" +} +``` + +Once you've created this file you must restart Tvheadend for it to take +affect. Note that for security the superuser account is not listed in the +access entries grid. + +**Tip**: Remember to set the correct permissions so that Tvheadend +is able to read the superuser file. + +--- diff --git a/docs/class/channel.md b/docs/class/channel.md index f14c4435b..7642e767a 100644 --- a/docs/class/channel.md +++ b/docs/class/channel.md @@ -32,6 +32,8 @@ Numbering Button | Function inc/add_grid_entry +####Example + !['Add Channel Dialog'](static/img/doc/addchanneldialog.png) --- diff --git a/docs/class/dvrentry.md b/docs/class/dvrentry.md index be6879ef4..30dd4c1c2 100644 --- a/docs/class/dvrentry.md +++ b/docs/class/dvrentry.md @@ -7,10 +7,10 @@ Each entry is moved between the tabs depending on its state: * Upcoming and currently recording entries remain in the *Upcoming/Current Recordings* tab. -* When a recording completes successfully the entry is moved to -the *Finished Recordings* tab. -* When a recording fails (or is aborted) the entry is moved to -the *Failed Recordings* tab. +* When a recording completes successfully the entry is moved +(from *Upcoming/Current Recordings*) to the *Finished Recordings* tab. +* When a recording fails (or is aborted) the entry is moved +(from *Upcoming/Current Recordings*) to the *Failed Recordings* tab. Please note that the grid in each tab may have different columns and not all entry information is available until it completes or fails, @@ -20,7 +20,7 @@ e.g filesize, total data errors, etc. ###Menu Bar/Buttons -The following functions are available: +The following functions are available in all tabs: Button | Function -----------------------------|--------- diff --git a/docs/class/mpegts_network.md b/docs/class/mpegts_network.md index 2e93dd454..a199475fc 100644 --- a/docs/class/mpegts_network.md +++ b/docs/class/mpegts_network.md @@ -49,11 +49,11 @@ most of which can be seen in the grid view. !['Add new network'](static/img/doc/addnewnetwork.png) -Pressing the *[Save]* button (at the bottom of the dialog) -will commit your changes and close the dialog, pressing the *[Apply]* -button will commit your changes but won't close the dialog, pressing -the *[Cancel]* button closes the dialog - any unsaved changes will be -lost. +Once you're happy with what you've entered into the dialog you can save +the network using the *[Save]* button (closing the dialog), save your +pending changes and continue making further adjustments by pressing the +*[Apply]* button, or cancel any unsaved changes (and close the dialog) +by pressing the *[Cancel]* button. **Notes**: diff --git a/docs/markdown/inc/add_grid_entry.md b/docs/markdown/inc/add_grid_entry.md index 806053818..84446909f 100644 --- a/docs/markdown/inc/add_grid_entry.md +++ b/docs/markdown/inc/add_grid_entry.md @@ -4,8 +4,9 @@ To add an entry click the *[Add]* button from the menu bar, the add dialog should now be displayed. A common set of fields is used for the add dialog, most of which can be seen in the grid view. -Pressing the *[Save]* button (at the bottom of the dialog) -will commit your changes and close the dialog, the *[Apply]* -button will commit your changes but won't close the dialog, -the *[Cancel]* button closes the dialog, any unsaved changes will be -lost. +Once you're happy with what you've entered into the dialog you can save +your entry using the *[Save]* button (closing the dialog), save your +pending changes and continue making further adjustments by pressing the +*[Apply]* button, or cancel any unsaved changes (and close the dialog) +by pressing the *[Cancel]* button. + diff --git a/docs/markdown/inc/edit_grid_entries.md b/docs/markdown/inc/edit_grid_entries.md index cafef24b4..f7227d8db 100644 --- a/docs/markdown/inc/edit_grid_entries.md +++ b/docs/markdown/inc/edit_grid_entries.md @@ -22,13 +22,11 @@ can now be kept (*[Save]* button), or abandoned (*[Undo]* button). Highlight (select) the entries in the grid that you'd like to edit, then click the *[Edit]* button from the menu bar, the edit dialog should now be displayed. A common set of fields is used for the edit dialog, most -of which can be seen in the grid view. -Note that when editing -multiple entries there is an additional check box before each setting, +of which can be seen in the grid view. Note that when editing multiple +entries there is an additional check box before each setting, ticking it will apply that setting to all selected entries. -Pressing the *[Save]* button (at the bottom of the dialog) -will commit your changes and close the dialog, pressing the *[Apply]* -button will commit your changes but won't close the dialog, pressing -the *[Cancel]* button closes the dialog - any unsaved changes will be -lost. +After you've finished editing an entry you can save your pending changes +using the *[Save]* button (closing the dialog), save your changes and continue making +further adjustments by pressing the *[Apply]* button, or cancel any unsaved +changes (and close the dialog) by pressing the *[Cancel]* button. -- 2.47.3