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

2019-06-17 Fred Gleason <fredg@paravelsystems.com>

Browse Source 
* Added an 'RDDbConfig' chapter to the Operations Guide.
	* Removed the 'Backing Up and Restoring the Database' section
	from the 'RDAdmin' chapter of the Operations Guide.
This commit is contained in:
Fred Gleason 2019-06-17 19:19:30 -04:00
parent 5f287b1628
commit 2a6254e035
7 changed files with 85 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -18780,3 +18780,7 @@
2019-06-17 Fred Gleason <fredg@paravelsystems.com>
* Updated the screenshot of the rdlibrary(1) Main Window in the
Operations Guide.
2019-06-17 Fred Gleason <fredg@paravelsystems.com>
* Added an 'RDDbConfig' chapter to the Operations Guide.
* Removed the 'Backing Up and Restoring the Database' section
from the 'RDAdmin' chapter of the Operations Guide.

7
docs/opsguide/Makefile.am
View File

@ -108,6 +108,10 @@ OPSGUIDE_HTML = appendix.filepath_wildcards.html\
sect.rdcatch.automating_switcher_operations.html\
sect.rdcatch.automating_uploads_downloads.html\
sect.rdcatch.the_rdcatch_main_window.html\
sect.rddbconfig.backing_up_and_restoring_the_database.html\
sect.rddbconfig.backing_up_the_database.html\
sect.rddbconfig.creating_a_new_database.html\
sect.rddbconfig.restoring_the_database_from_a_backup.html\
sect.rdlibrary.alternative_methods_of_audio_ingestion.html\
sect.rdlibrary.generating_library_reports.html\
sect.rdlibrary.library_maintenance.html\
@ -225,6 +229,8 @@ OPSGUIDE_IMAGES = rdadmin.audio_resource_information_dialog.png\
rdcatch.edit_switcher_event_dialog.png\
rdcatch.edit_upload_dialog.png\
rdcatch.rdcatch_screenshot.png\
rddbconfig.login_dialog.png\
rddbconfig.rddbconfig_screenshot.png\
rdlibrary.cd_ripper_dialog.png\
rdlibrary.edit_cart_dialog.png\
rdlibrary.edit_cut_info_dialog.png\
@ -292,6 +298,7 @@ OPSGUIDE_DEPS = $(OPSGUIDE_IMAGES) \
rdairplay.xml\
rdcartslots.xml\
rdcatch.xml\
rddbconfig.xml\
rdlibrary.xml\
rdlogedit.xml\
rdlogin.xml\

2
docs/opsguide/opsguide.xml
View File

@ -16,6 +16,7 @@
<!ENTITY rml SYSTEM "rml.xml">
<!ENTITY utilities SYSTEM "utilities.xml">
<!ENTITY rdadmin SYSTEM "rdadmin.xml">
<!ENTITY rddbconfig SYSTEM "rddbconfig.xml">
<!ENTITY gfdl SYSTEM "gfdl.xml">
<!ENTITY gplv2 SYSTEM "gplv2.xml">
<!ENTITY gpio_switcher_devices SYSTEM "gpio_switcher_devices.xml">
@ -43,6 +44,7 @@
<part xml:id="part.rivendell_administration" xmlns="http://docbook.org/ns/docbook" version="5.0">
<title>Rivendell Administration</title>
&rdadmin;
&rddbconfig;
&rml;
&pad;
&utilities;

21
docs/opsguide/rdadmin.xml
View File

@ -2509,25 +2509,4 @@
to be replicated should be taken.
</para>
</sect1>
<sect1 xml:id="sect.rdadmin.backing_up_and_restoring_the_database">
<title>Backing Up and Restoring the Database</title>
<para>
To make a backup copy of the database, touch the
<computeroutput>Backup Database</computeroutput> button. You will
be prompted with a dialog to allow you to choose a location to save
the resulting backup.
</para>
<para>
To restore a previous backup, touch the
<computeroutput>Restore Database</computeroutput> button. You will
be prompted with a dialog to allow you to choose a location whence
to load the back file.
</para>
<warning>
<para>
Restoring a previous database will COMPLETELY OVERWRITE whatever
database is currently loaded!
</para>
</warning>
</sect1>
</chapter>

BIN
docs/opsguide/rddbconfig.login_dialog.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

BIN
docs/opsguide/rddbconfig.rddbconfig_screenshot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 17 KiB

72
docs/opsguide/rddbconfig.xml Normal file
View File

@ -0,0 +1,72 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="chapter.rddbconfig">
<title>Managing the Rivendell Database with RDDbConfig</title>
<sect1 xml:id="sect.rddbconfig.overview">
<title>Overview</title>
<para>
RDDbConfig is a GUI module that allows basic administration
(creation, upgrading, backup and restoration) of a Rivendell database.
</para>
<para>
When starting up RDDbConfig, you will be prompted to enter the 'root'
password for the system.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rddbconfig.login_dialog.png" scale="45"/>
</imageobject>
<caption>
<para>The Root Login Dialog</para>
</caption>
</mediaobject>
</para>
<para>
After entering the correct 'root' password, the main RDDbConfig
window will be displayed.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rddbconfig.rddbconfig_screenshot.png" scale="50"/>
</imageobject>
<caption>
<para>The RDDbConfig Main Window</para>
</caption>
</mediaobject>
</para>
</sect1>
<sect1 xml:id="sect.rddbconfig.creating_a_new_database">
<title>Creating a New Database</title>
A 'new' database --i.e. one that contains only default objects --
can be generated by touching the <computeroutput>Create</computeroutput>
button.
<warning>
Generating a new database will COMPLETELY OVERWRITE whatever
database is currently loaded!
</warning>
</sect1>
<sect1 xml:id="sect.rddbconfig.backing_up_the_database">
<title>Backing Up the Database</title>
<para>
To make a backup copy of the database, touch the
<computeroutput>Backup</computeroutput> button. You will
be prompted with a dialog to allow you to choose a location to save
the resulting backup.
</para>
</sect1>
<sect1 xml:id="sect.rddbconfig.restoring_the_database_from_a_backup">
<title>Restoring the Database from a Backup</title>
<para>
To restore a previous backup, touch the
<computeroutput>Restore</computeroutput> button. You will
be prompted with a dialog to allow you to choose a location whence
to load the back file.
</para>
<warning>
Restoring a previous database will COMPLETELY OVERWRITE whatever
database is currently loaded!
</warning>
</sect1>
</chapter>