Rivendellaudio/docs/opsguide/rddbconfig.xml
Fred Gleason b5a1831655 2022-05-20 Fred Gleason <fredg@paravelsystems.com>
* Updated the 'Managing the Rivendell Database with RDDbConfig'
	chapter of the Operations Guide.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
2022-05-20 11:12:51 -04:00

77 lines
2.6 KiB
XML

<?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" width="60mm" depth="42mm"/>
</imageobject>
<caption>
<para>The Root Login Dialog</para>
</caption>
</mediaobject>
</para>
<note>
The appearance of the Root Login Dialog may vary depending on desktop
environment in use!
</note>
<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" width="50mm" depth="63mm"/>
</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>