Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
mdhelp: access entry update (plus screenshot) mdhelp: add title forma…
…tting info to dvr_timerec
  • Loading branch information
Mark Clarkstone authored and perexg committed Apr 14, 2016
1 parent 0cff623 commit 2a4dea2
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/class/access_entry.md
Expand Up @@ -8,3 +8,47 @@ combined for all matching access entries. 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.

---

### Adding an Entry/Creating an Account

To create a new user, navigate to the *Configuration -> Users -> Access Entries*
tab and click on the *[Add]* button from the menu bar, then using the
*Add Access Entry* dialog enter the *required* username and select the
desired rights options.

If you would like to allow anonymous access to your Tvheadend
server you may set-up an anonymous account by entering an asterisk `*`
in the username field. **WARNING: All access rights given to an anonymous account also
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!

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

---

### Editing an Entry/Account

To edit an entry highlight (select) the entry from the grid then press
the *[Edit]* button from the menu bar.

**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 a User.

To delete a user highlight (select) the entry from the grid then press
the *[Delete]* button from the menu bar.

Binary file added docs/docresources/accessentriesnewuser.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions docs/property/dvr_timerec_title_format.md
@@ -0,0 +1,10 @@
:

String | Format Result
------ | -------------
%F | The date in ISO-format (e.g. 2015-02-28).
%R | The time in 24h HH:MM format (e.g. 19:45).
%x | The date, formatted according to your locale settings.

The escape-codes use
[strftime](http://man7.org/linux/man-pages/man3/strftime.3.html) format.
9 changes: 9 additions & 0 deletions src/dvr/dvr_timerec.c
Expand Up @@ -517,6 +517,14 @@ dvr_timerec_entry_class_owner_opts(void *o)
return PO_RDONLY | PO_ADVANCED;
}

static char *
dvr_timerec_prop_titleformat_doc(const struct property *p, const char *lang)
{
extern const char *tvh_doc_dvr_timerec_title_format_property[];
return prop_md_doc(tvh_doc_dvr_timerec_title_format_property, lang);
}


extern const char *tvh_doc_dvrtimerec_class[];

const idclass_t dvr_timerec_entry_class = {
Expand Down Expand Up @@ -549,6 +557,7 @@ const idclass_t dvr_timerec_entry_class = {
.id = "title",
.name = N_("Title"),
.desc = N_("Title of the recording."),
.doc = dvr_timerec_prop_titleformat_doc,
.off = offsetof(dvr_timerec_entry_t, dte_title),
.def.s = "Time-%F_%R",
},
Expand Down

0 comments on commit 2a4dea2

Please sign in to comment.