Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
docs: first import from tvheadend-documentation
  • Loading branch information
@perexg
perexg committed Jun 12, 2015
1 parent 4ab50d4 commit a7c2815
Show file tree
Hide file tree
Showing 28 changed files with 2,316 additions and 2,650 deletions.
5 changes: 5 additions & 0 deletions docs/html/en/about.html
View file
@@ -0,0 +1,5 @@
<!-- Do not edit! Automatically created file: https://github.com/tvheadend/tvheadend-documentation -->
<div class="hts-doc-text">
<h3>About</h3>
<p>Content Required. Please add some!</p>
</div>
233 changes: 79 additions & 154 deletions docs/html/en/config_access.html
View file
@@ -1,156 +1,81 @@
<!-- Do not edit! Automatically created file: https://github.com/tvheadend/tvheadend-documentation -->
<div class="hts-doc-text">

Setting up access control is an important initial step as the system initially is
wide open.

<img src="docresources/accessconfig.png">

<p>
When Tvheadend verifies access is scan through all the enabled access control entries.
The permission flags, streaming profiles, DVR config profiles, channel tags are 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.
<p>

The access rules are listed / edited in a grid.

<ul>
<li>To edit a cell, double click on it. After a cell is changed it
will flags one of its corner to red to indicated that it has been
changed. To commit these changes back to Tvheadend press the
'Save changes' button. In order to change a Checkbox cell you only
have to click once in it.

<li>To add a new entry, press the 'Add entry' button. The new (empty) entry
will be created on the server but will not be in its enabled state.
You can now change all the cells to the desired values, check the
'enable' box and then press 'Save changes' to activate the new entry.

<li>To delete one or more entries, select the lines (by clicking once on
them), and press the 'Delete selected' button. A popup
will ask you to confirm your request.
</ul>

<p>
<br>
<hr>
<b>Columns</b>
<hr>
The columns have the following functions:
<br><br>

<dl>
<dt><b>Enabled</b>
<dd>Enable this access control rule. Uncheck the box to disable.

<dt><b>Username</b>
<dd>
Login name to be used. If no username is required, this entry should contain a single asterisk (*).

<dt><b>Network prefix</b>
<dd>
IPv4 prefix for matching based on source IP address.
If set to 0.0.0.0/0 it will match everything.
The multiple networks can be delimited using comma or semicolon.

<dt><b>Web interface</b>
<dd>
Required for web user interface access. Also gives access to the EPG.

<dt><b>Admin</b>
<dd>
Enables access to the Configuration tab.

<dt><b>Streaming</b>
<dd>
Enables access to streaming functionality for HTTP (web).

<dt><b>Advanced Streaming</b>
<dd>
Enables access to advanced streaming function for HTTP (web) - like direct
service or whole MPEG-TS stream (mux)..

<dt><b>HTSP Streaming</b>
<dd>
Enables access to streaming for the HTSP protocol (Movian, Kodi etc.).

<dt><b>Streaming Profile</b>
<dd>
Specify a streaming profile to be used when this user logs in; use the (default) stream if not specified.

<dt><b>Connection Limit Type</b>
<dd>
Allow to restrict the limit for connections to streaming or DVR only.

<dt><b>Limit Connections</b>
<dd>
If set, this will limit the number of concurrent streaming connections and
DVR sessions a user is permitted to have. 0=disabled

<dt><b>Video Recorder</b>
<dd>
Enables access to all video recording functions. This also include administration of the auto recordings.

<dt><b>HTSP DVR</b>
<dd>
Enables access to video recording functions for the HTSP protocol (Movian, Kodi etc.).

<dt><b>All DVR</b>
<dd>
Enable to access to DVR entries created by other users (read-only).

<dt><b>All DVR (rw)</b>
<dd>
Enable to access to DVR entries created by other users with the ability to
remove the DVR entries.

<dt><b>Failed DVR</b>
<dd>
Enable to access to DVR entries which were not succesfuly recorded.

<dt><b>DVR Config Profile</b>
<dd>
If set, the user will only be able to use the DVR config profile
equal to this value.
Note that this field is unset when the DVR Config Profile is removed.

<dt><b>Min Channel Num</b>
<dd>
If non-zero, this sets the lower limit of the channels accessible by a user, i.e. the user will only be able to access channels where the channel number is equal to or greater than this value.

<dt><b>Max Channel Num</b>
<dd>
If non-zero, this sets the upper limit of the channels accessible by a user, i.e. the user will only be able to access channels where the channel number is equal to or less than this value.

<dt><b>Channel Tag</b>
<dd>
If set, the user will only be able to access channels containing
this channel tag.
Note that this field is unset when the channel tag is removed.

<dt><b>Comment</b>
<dd>
Allows the administrator to set a comment only visible in this editor.
It does not serve any active purpose.
</dl>

<p>
<br>
<hr>
Let's also take a look at an example:
<p>
<img src="docresources/accessconfigexample.png">
<p>
First line gives clients originating from 192.168.0.0 - 192.168.0.255 network
access to streaming functions. Typically you would use this for your
local media players at home (All though Movian can prompt for username & password
in its HTSP client)
<p>
The second line adds a user with world wide access who might want to modify
recordings, etc, perhaps from the job, or mobile phone.
<p>
The third line provide admin access to the 'admin' user. As an extra precaution this
user is only allowed to log in from the home network.
<p>

<h3>Configuration - Access Entries</h3>
<p>Setting up access control is an important initial step as <strong><u>the system
is initially wide open</u></strong> .</p>
<p>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 and so on are combined for all matching access entries. An access entry is said to match if the username / password matches and the IP source address of the requesting peer is within the prefix.</p>
<p><img src="docresources/accessconfig.png" alt="&#39;Access Entries&#39; Tab" /></p>
<hr />
<h5>Menu Bar/Buttons</h5>
<p>The following functions are available:</p>
<table>
<thead><tr>
<th>Button</th>
<th>Function </th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Save</strong></td>
<td>Save any changes made to the access rules. </td>
</tr>
<tr>
<td><strong>Undo</strong></td>
<td>Undo any changes made to the access rules since the last save. </td>
</tr>
<tr>
<td><strong>Add</strong></td>
<td>Add a new access rule. </td>
</tr>
<tr>
<td><strong>Delete</strong></td>
<td>Delete the selected access rule. </td>
</tr>
<tr>
<td><strong>Move up</strong></td>
<td>Move the selected rule up one level (rules are executed top to bottom). </td>
</tr>
<tr>
<td><strong>Move down</strong></td>
<td>Move the selected rule down one level (rules are executed top to bottom).</td>
</tr>
<tr>
<td><strong>Edit</strong></td>
<td>Edit the selected access rule. </td>
</tr>
<tr>
<td><strong>Help</strong></td>
<td>Display this help page. </td>
</tr>
</tbody>
</table>
<hr />
<h5>Grid Items</h5>
<p>The main grid items have the following functions:</p>
<p><strong>Enabled</strong> : Enable this access control rule. Uncheck the box to disable.</p>
<p><strong>Username</strong> : Login name to be used. If no username is required, this entry should contain a single asterisk (<code>*</code>).</p>
<p><strong>Network prefix</strong> : IPv4 prefix for matching based on source IP address. If set to <code>0.0.0.0/0</code> it will match everything. The multiple networks can be delimited using comma or semicolon.</p>
<p><strong>Web interface</strong> : Required for web user interface access. Also gives access to the EPG.</p>
<p><strong>Admin</strong> : Enables access to the Configuration tab.</p>
<p><strong>Streaming</strong> : Enables access to streaming functionality for HTTP (web).</p>
<p><strong>Advanced Streaming</strong> : Enables access to advanced streaming function for HTTP (web) - like direct service or whole MPEG-TS stream (mux)..</p>
<p><strong>HTSP Streaming</strong> : Enables access to streaming for the HTSP protocol (Movian, Kodi etc.).</p>
<p><strong>Streaming Profile</strong> : Specify a streaming profile to be used when this user logs in; use the (default) stream if not specified.</p>
<p><strong>Connection Limit Type</strong> : Allow to restrict the limit for connections to streaming or DVR only.</p>
<p><strong>Limit Connections</strong> : If set, this will limit the number of concurrent streaming connections and DVR sessions a user is permitted to have. 0=disabled</p>
<p><strong>Video Recorder</strong> : Enables access to all video recording functions. This also include administration of the auto recordings.</p>
<p><strong>HTSP DVR</strong> : Enables access to video recording functions for the HTSP protocol (Movian, Kodi etc.).</p>
<p><strong>All DVR</strong> : Enable to access to DVR entries created by other users (read-only).</p>
<p><strong>All DVR (rw)</strong> : Enable to access to DVR entries created by other users with the ability to remove the DVR entries.</p>
<p><strong>DVR Config Profile</strong> : If set, the user will only be able to use the DVR config profile equal to this value. Note that this field is unset when the DVR Config Profile is removed.</p>
<p><strong>Min Channel Num</strong> : If non-zero, this sets the lower limit of the channels accessible by a user, i.e. the user will only be able to access channels where the channel number is equal to or greater than this value.</p>
<p><strong>Max Channel Num</strong> : If non-zero, this sets the upper limit of the channels accessible by a user, i.e. the user will only be able to access channels where the channel number is equal to or less than this value.</p>
<p><strong>Channel Tag</strong> : If set, the user will only be able to access channels containing this channel tag. Note that this field is unset when the channel tag is removed.</p>
<p><strong>Comment</strong> : Allows the administrator to set a comment only visible in this editor. It does not serve any active purpose.</p>
<hr />
<p>Let’s also take a look at an example:</p>
<p><img src="docresources/accessconfigexample.png" alt="Access Entries Example" /></p>
<p>The first line gives clients originating from <em>192.168.0.0 - 192.168.0.255</em> network access to streaming functions. Typically, you would use this for your local media players at home (Although Movian can prompt for username and password in its HTSP client)</p>
<p>The second line adds a user with world wide access who might want to modify recordings, etc., perhaps from their workplace or via a mobile 'phone.</p>
<p>The third line provide admin access to an <em>admin</em> user. As an extra precaution this user is only allowed to log in from the home network.</p>
</div>
96 changes: 55 additions & 41 deletions docs/html/en/config_bouquet.html
View file
@@ -1,43 +1,57 @@
<!-- Do not edit! Automatically created file: https://github.com/tvheadend/tvheadend-documentation -->
<div class="hts-doc-text">

<p>
To use bouquets, ensure to add and scan all available muxes using
the predefined muxes or manual configuration.
</p>

<p>
The bouquets are obtained automatically from the DVB source during
the mux scan period. Note that bouquets may use more muxes and only
services from scanned muxes are added. The mux with bouquets might
require another scan when all muxes are discovered (manually using
the rescan checkbox).
</p>

<p>
The fastscan bouquets are pre-defined in the configuration tree. These
bouquets must be manually enabled to let tvheadend to subscribe and listen
to the specific MPEG-TS PIDs.
</p>

<p>
The bouquets are listed / edited in a grid.

<ul>
<li>To edit a cell, double click on it. After a cell is changed it
will flags one of its corner to red to indicated that it has been
changed. To commit these changes back to Tvheadend press the
'Save changes' button. In order to change a Checkbox cell you only
have to click once in it.

<li>To add a new entry, press the 'Add entry' button. The new (empty) entry
will be created on the server but will not be in its enabled state.
You can now change all the cells to the desired values, check the
'enable' box and then press 'Save changes' to activate the new entry.

<li>To delete one or more entries, select the lines (by clicking once on
them), and press the 'Delete selected' button. A popup
will ask you to confirm your request.
</ul>
</p>

<h3>Configuration - Channel/EPG - Bouquets</h3>
<p>Bouquets are broadcaster-defined groupings and orders of channels.</p>
<h3>NOTE: <font color=red>SCREENSHOT HERE</font></h3>
<p>To use bouquets, ensure to add and scan all available muxes using the predefined muxes or manual configuration.</p>
<p>The bouquets are obtained automatically from the DVB source during the mux scan period. Note that bouquets may use more muxes and only services from scanned muxes are added. The mux with bouquets might require another scan when all muxes are discovered (manually using the rescan checkbox).</p>
<p>The fastscan bouquets are pre-defined in the configuration tree. These bouquets must be manually enabled to let Tvheadend to subscribe and listen to the specific MPEG-TS PIDs.</p>
<hr />
<h5>Menu Bar/Buttons</h5>
<p>The following functions are available:</p>
<table>
<thead><tr>
<th>Button</th>
<th>Function </th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Save</strong></td>
<td>Save any changes made to the bouquet configuration. </td>
</tr>
<tr>
<td><strong>Undo</strong></td>
<td>Undo any changes made to the bouquetconfiguration since the last save. </td>
</tr>
<tr>
<td><strong>Delete</strong></td>
<td>Delete an existing bouquet. </td>
</tr>
<tr>
<td><strong>Edit</strong></td>
<td>Edit an existing bouquet. This allows you to change any of the parameters you’d otherwise set when adding a new channel, e.g. enabled, map radio, etc.</td>
</tr>
<tr>
<td><strong>Help</strong></td>
<td>Displays this help page. </td>
</tr>
</tbody>
</table>
<hr />
<h5>Grid Items</h5>
<p>The main grid items have the following functions:</p>
<p><strong>Enabled</strong> : <font color=red>Text...</font></p>
<p><strong>Rescan</strong> : <font color=red>Text...</font></p>
<p><strong>Name</strong> : <font color=red>Text...</font></p>
<p><strong>Auto-Map to Channels</strong> : <font color=red>Text...</font></p>
<p><strong>Map Zero Numbers</strong> : <font color=red>Text...</font></p>
<p><strong>Channel Number Offset</strong> : <font color=red>Text...</font></p>
<p><strong>Map No Name</strong> : <font color=red>Text...</font></p>
<p><strong>Map Radio</strong> : <font color=red>Text...</font></p>
<p><strong>Create Tag</strong> : <font color=red>Text...</font></p>
<p><strong>Source</strong> : <font color=red>Text...</font></p>
<p><strong># Services</strong> : <font color=red>Text...</font></p>
<p><strong># Seen Services</strong> : <font color=red>Text...</font></p>
<p><strong>Comment</strong> : <font color=red>Text...</font></p>
</div>

0 comments on commit a7c2815

Please sign in to comment.