Autres/Rivendellaudio
1
0
Fork 0
mirror of https://github.com/ElvishArtisan/rivendell.git synced 2025-04-09 22:43:11 +02:00
Code Issues Projects Releases Wiki Activity

2020-11-16 Fred Gleason <fredg@paravelsystems.com>

Browse Source 
* Rewrote the 'Webget' chapter of the Operations Guide to conform
	to changes in Webget.
	* Added a 'Configuring Webget' section to the Operations Guide.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
Fred Gleason 2020-11-16 20:12:52 -05:00
parent 4b76e2e79e
commit 3edd916f6c
7 changed files with 148 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -20592,3 +20592,7 @@
2020-11-16 Fred Gleason <fredg@paravelsystems.com>
* Modified the Webget service to require the 'Create Carts'
priviledge in order to upload content.
2020-11-16 Fred Gleason <fredg@paravelsystems.com>
* Rewrote the 'Webget' chapter of the Operations Guide to conform
to changes in Webget.
* Added a 'Configuring Webget' section to the Operations Guide.

2
docs/opsguide/Makefile.am
View File

@ -158,7 +158,9 @@ OPSGUIDE_IMAGES = rdadmin.audio_resource_information_dialog.png\
rdadmin.configure_rdpanel_dialog.png\
rdadmin.dropbox_configuration_dialog.png\
rdadmin.edit_audio_ports_dialog.png\
rdadmin.edit_audio_settings_dialog.png\
rdadmin.edit_channel_gpios_dialog.png\
rdadmin.encoder_profiles_dialog.png\
rdadmin.edit_gpi_dialog.png\
rdadmin.edit_host_variable_dialog.png\
rdadmin.edit_pypad_instance_dialog.png\

BIN
docs/opsguide/rdadmin.edit_audio_settings_dialog.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 19 KiB

BIN
docs/opsguide/rdadmin.encoder_profiles_dialog.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

90
docs/opsguide/rdadmin.xml
View File

@ -2651,4 +2651,94 @@
to be replicated should be taken.
</para>
</sect1>
<sect1 xml:id="sect.rdadmin.configuring_webget">
<title>Configuring Webget</title>
<para>
Configuration of the Webget service consists of two tasks:
</para>
<itemizedlist>
<listitem>
<para>
Configure a set of Encoder Formats
</para>
</listitem>
<listitem>
<para>
Configure one or more Users for access
</para>
</listitem>
</itemizedlist>
<sect2 xml:id="sect.rdadmin.configuring_encoder_formats">
<title>Configuring Encoder Formats</title>
<para>
To configure Encoder Formats, log in to
<command>rdadmin</command><manvolnum>1</manvolnum>, touch the
<computeroutput>System Settings</computeroutput> button to open
the <computeroutput>System-Wide Settings</computeroutput> button,
then touch the <computeroutput>Edit Encoder List</computeroutput>
button to open the <computeroutput>Encoder Profiles</computeroutput>
dialog.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdadmin.encoder_profiles_dialog.png" scale="50"/>
</imageobject>
<caption>
<para>The Encoder Profiles Dialog</para>
</caption>
</mediaobject>
</para>
<para>
To add a new Encoder Profile, touch the
<computeroutput>Add</computeroutput> button to open the
<computeroutput>Edit Audio Settings</computeroutput> dialog.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdadmin.edit_audio_settings_dialog.png" scale="50"/>
</imageobject>
<caption>
<para>The Edit Audio Settings Dialog</para>
</caption>
</mediaobject>
</para>
<para>
Enter the description of the Profile to appear in Webget, select
the desired audio parameters and then touch the
<computeroutput>OK</computeroutput> button.
</para>
<para>
Exiting Encoder Profiles can be modified or deleted by means of
the <computeroutput>Edit</computeroutput> and
<computeroutput>Delete</computeroutput> buttons, respectively.
</para>
</sect2>
<sect2 xml:id="sect.rdadmin.configuring_webget_users">
<title>Configuring Webget Users</title>
<para>
To configure one or more users for Webget access, log in to
<command>rdadmin</command><manvolnum>1</manvolnum>, touch the
<computeroutput>Manage Users</computeroutput> button to open
the <computeroutput>Rivendell User List</computeroutput> button,
then create or select the desired user to open the
<computeroutput>User</computeroutput> dialog.
</para>
<para>
For downloads, each Webget user must have the
<computeroutput>Allow WebGet Login</computeroutput> permission enabled,
as well as rights to one or more Groups set by touching the
<computeroutput>Group Permissions</computeroutput> button.
</para>
<para>
For uploads, each Webget user must have the
<computeroutput>Allow WebGet Login</computeroutput> and
<computeroutput>Create Carts</computeroutput> permissions enabled,
as well as rights to one or more Groups set by touching the
<computeroutput>Group Permissions</computeroutput> button.
</para>
</sect2>
</sect1>
</chapter>

BIN
docs/opsguide/webget.webget_screen.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 53 KiB

72
docs/opsguide/webget.xml
View File

@ -3,36 +3,68 @@
<sect1 xml:id="sect.webget.webget">
<title>Webget</title>
<para>
Webget is a web-based utility for downloading Rivendell audio content
from remote locations. It can be accessed at
<userinput>http://<replaceable>host-name</replaceable>/rd-bin/webget.html</userinput>, where <replaceable>host-name</replaceable> is the host name or
Webget is a web-based utility for up- and down-loading Rivendell
audio content to and from remote locations. It can be accessed at
<userinput>http://<replaceable>host-name</replaceable>/rd-bin/webget.cgi</userinput>, where <replaceable>host-name</replaceable> is the host name or
IP address of the Rivendell system.
</para>
<note>
Depending on the site-specific configuration of Rivendell, Webget
may need to be accessed at
<userinput>https://<replaceable>host-name</replaceable>/rd-bin/webget.cgi</userinput>.
</note>
<para>
After entering a set of valid credentials, the user will be taken to
the main Webget screen:
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="webget.webget_screen.png" scale="60"/>
<imagedata align="center" fileref="webget.webget_screen.png" scale="50"/>
</imageobject>
<caption><para>The Webget screen</para></caption>
</mediaobject>
</para>
<para>
Content in Webget is searched for on the basis of the Cart's
<computeroutput>Title</computeroutput> field. The format of the
downloaded audio can be specified. Credentials for a valid Rivendell user
that has the <computeroutput>Production Rights/Allow WebGet Login</computeroutput>
priviledge enabled in <command>rdadmin</command><manvolnum>1</manvolnum>
must be provided. Click the <computeroutput>OK</computeroutput>
button to generate the audio.
</para>
<note>
If multiple carts with the specified title exist, then the cart
with the lowest <computeroutput>Cart Number</computeroutput> will
be used.
</note>
<note>
If the selected cart contains multiple cuts, then the cut with the
lowest <computeroutput>Cut Number</computeroutput> will be used.
To configure Webget, see the
<link linkend="sect.rdadmin.configuring_webget">Configuring Webget</link>
section in <link linkend="sect.rdadmin.overview">
Configuring Rivendell with RDAdmin</link>.
</note>
<sect2 xml:id="sect.webget.webget.downloading_audio">
<title>Downloading Audio</title>
<para>
Content can be downloaded using Webget by entering the
<computeroutput>Title</computeroutput> of the desired Cart in the
<computeroutput>From Cart Title</computeroutput> field, with the
format of the downloaded audio selected by means of the
<computeroutput>Using Format</computeroutput> dropdown.
Touch the <computeroutput>OK</computeroutput>
button to initiate the download.
</para>
<note>
If multiple carts with the specified title exist, then the cart
with the lowest <computeroutput>Cart Number</computeroutput> will
be used.
</note>
<note>
If the selected cart contains multiple cuts, then the cut with the
lowest <computeroutput>Cut Number</computeroutput> will be used.
</note>
</sect2>
<sect2 xml:id="sect.webget.webget.uploading_audio">
<title>Uploading Audio</title>
<para>
Content can be uploaded using Webget by selecting the desired
audio file with the <computeroutput>From File</computeroutput>
browser button, selecting the destination Rivendell Group from
the <computeroutput>To Group</computeroutput> dropdown and then
touching the <computeroutput>OK</computeroutput> button.
</para>
<para>
After the upload is complete, Webget will display a dialog with
the Cart Number and Title containing the uploaded audio.
</para>
</sect2>
</sect1>
</chapter>