Backup Schedule


KeyServer allows you to automatically back up your most critical KeyServer-related data, i.e., the data you've entered into the system after setting the KeyServer up. In the event of a crash the executable files can of course be easily downloaded from the Sassafras website, but this is not the case for custom configuration data concerning the programs your KeyServer is controlling, the portable keys that are currently signed out, the usage and audit data you've collected, and so on.

By default, backup files are placed in the KeyServer Data Folder in a sub-folder named “Backup Folder” . To protect against total loss due to disk failure, it is much better to store these backup files on a separate volume.

Replace the “Backup Folder” inside the KeyServer data Folder with a shortcut (or alias, or symbolic link) likewise named “Backup Folder” – configure the shortcut to resolve to a folder on a separate volume, perhaps located on a remote server. Make sure that the KeyServer process has file create and modify privileges in the target location for backups. Note: on Windows you may need to reconfigure the KeyServer service to run in a non-SYSTEM account which is set to auto-mount a remote backup drive with these privileges.

We strongly recommend that you set a backup schedule soon after setting up your KeyServer, and that you configure the backup location on a separate volume. The configuration data in these files is otherwise irreplaceable and if lost must be regenerated from scratch. Although an external backup solution can be used in conjunction with the built in backup process, the external backup solution will not be able to reliably backup the database files that are open and in use - these must be backed up either by the built in backup process or when the KeyServer process is stopped.

OPEN Backup Schedule dialog

Select “Backup Schedule...” from the Admin menu to set a daily, multi-day, or weekly backup schedule. The following dialog appears.

Change backup schedule dialog

Enter the time at which you want the backup to occur, and enter the day(s) of the week on which you want the backups to be done. The backup process will run at any time without interrupting normal KeyServer service – but you may want to choose a time in the night that avoids possible disk contention in case the KeyServer host computer is simultaneously supporting other disk intensive tasks. The Backup Now button can be used to perform an immediate backup regardless of whether a schedule has been defined.

The Backup Folder is organized with a sub-folder for each day of the week plus an Unscheduled sub-folder for "immediate" backups. The critical data files being backed up are all at the root level of the KeyServer Data Folder:

KeyServer Data Folder important site data
server.lic your KeyServer license certificate (and other files with the ".lic" extension)
Admin Permissions Accounts. Passwords, and Permissions for KeyConfigure
Computer Database computer identity database
KeyServer Preferences KeyServer settings file
License Data controlled program database
Location Filter Database network access database
Portable Use Record checked out licenses database
Program Database program information database
Reservations Record schedules database
Software Audit Database audit information database
Usage Index Database program and license usage database
Usage Log program and license usage database
Authent List users/passwords/groups list, needed only when using Text Authent method

 

In case of disaster, first create a new KeyServer installation using the server installer appropriate for the host platform - but don't start the KeyServer process. Then copy in all the files listed above from your latest backup (replacing any default copies created by the installer). Then start the KeyServer process. Note: your backed up data files are useable under any host operating system – there is no requirement that you resurrect the KeyServer on the same host or operating system that failed (but of course you will want to preserve the same dns name so that clients can find the new installation).

Alternately, if a standard file system backup exists of the entire Server folder (containing the ks executable and its KeyServer Data Folder), you can use it to restore the KeyServer executable program and the KeyServer Data Folder into its usual location. Then re-run the KeyServer installer just as an easy way to get the automatic startup of the KeyServer process configured.

For a complete list of all KeyServer components, data files, etc. see the Complete File List document.


Help Index 2009.09.01

Related Topics

Exporting
Log File Management
Complete FIle List

Help Index
?