Skip to content

Commit

Permalink
mdhelp: clean-up and add superuser access info
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark Clarkstone authored and perexg committed Jun 21, 2016
1 parent 55fec0f commit 3e3cad1
Show file tree
Hide file tree
Showing 6 changed files with 56 additions and 26 deletions.
35 changes: 32 additions & 3 deletions docs/class/access_entry.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -66,3 +66,32 @@ username and password fields when adding the entry).
<tvh_include>inc/del_grid_entries</tvh_include>

---

###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.

---
2 changes: 2 additions & 0 deletions docs/class/channel.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ Numbering Button | Function

<tvh_include>inc/add_grid_entry</tvh_include>

####Example

!['Add Channel Dialog'](static/img/doc/addchanneldialog.png)

---
Expand Down
10 changes: 5 additions & 5 deletions docs/class/dvrentry.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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
-----------------------------|---------
Expand Down
10 changes: 5 additions & 5 deletions docs/class/mpegts_network.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**:

Expand Down
11 changes: 6 additions & 5 deletions docs/markdown/inc/add_grid_entry.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

14 changes: 6 additions & 8 deletions docs/markdown/inc/edit_grid_entries.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 3e3cad1

Please sign in to comment.