REDEYEDMS. On-site backup documentation for WINDOWS. Commercial in Confidence. Version 1.5 Engineer: Date: 23 October 2017.

Transcription

1 REDEYEDMS On-site backup documentation for WINDOWS Commercial in Confidence Version 1.5 Engineer: Nicolas Dijoux Date: 23 October 2017 RedEye Apps Brisbane Houston Palo Alto

2 CONTENTS 1. Overview operating system support Security Security credentials Firewalls 3 4. Backed up files Installation Windows 4 6. Event logs Just RedEye It. Page 2 of 8

3 1. OVERVIEW The onsite backup solution enables our clients to back up all their files from RedEye onto their own servers. The solution also downloads a registry of all revisions and their essential metadata that we automatically generate once a day. 2. OPERATING SYSTEM SUPPORT We support the following Operating Systems Mac OS X Windows Servers 2010+, Windows XP/Vista/7/8/10 Linux 3. SECURITY 3.1. Security credentials During the installation phase, one of our engineers will assist you and securely provide you your backup credentials. These credentials will allow the backup solution to access very specific data in your RedEye bucket. It is your responsibility to keep them safe, and to request new credentials when necessary Firewalls The backup solution uses AWS S3 endpoints to synchronise your data. Unfortunately, S3 IP addresses keep changing, which may be an issue if you have a firewall guarding your servers. To remedy this issue: We can provide you with all S3 IP ranges that would need to be whitelisted by your network administrator, and which would open your servers to send and receive data from all available AWS S3 servers, and which could be a security concern for you. You can set up a proxy server with or without credentials and enter the details in the backup solution during installation. Alternatively, we can roll out a proxy server in multiple availability zones close to your region and provide you with a single IP address to whitelist. This solution involves an extra cost to deploy and maintain the instance. RedEye Apps Brisbane Houston Palo Alto

4 4. BACKED UP FILES The backup solution backs up the following files: All original uploaded files (Drawings, Documents and Media) The daily revisions and metadata registry in CSV format And optionally, all previews that were generated by RedEye 5. INSTALLATION 5.1. Windows You must be an Administrator to install and setup the backup solution Open the command prompt as an Administrator of the system and run the following: dms-backup.exe init i You will be prompted to enter values for the following options: Storage path Proxy: - Host - Username The path of the directory/folder you want all backed up files to be stored locally. If you have a proxy server: Host must be prefixed with or and suffixed with the port number. Just RedEye It. Page 4 of 8

5 - Password Example: The username and password are optional and can be left empty if no credentials are required Client ID Access Key Secret Key Region Schedule settings Your bucket ID in RedEye Is the access key provided by one of our engineers Is the secret key provided by one of our engineers If you are based in the US, it is likely that the region is us. Otherwise, choose au for Australia. This is where you set the recurrence of the backup task in CRON format. It is important to note that you cannot set backup jobs to occur within less than 12 hours of each other, and you will be asked to enter the value again if the input is invalid. Examples: Every day at 6PM: 0 18 * * * Every 12 hours: 0 */12 * * * For more information, please visit: Backup items (Previews) You have the option to back up all generated previews from RedEye. It is important to note that this will drastically increase the size of the backup, and the previews are usually high-quality images. Just RedEye It. Page 5 of 8

6 Number of concurrent requests This is the number of concurrent requests processed by the backup solution. If 0, it will automatically set to the default value of 20 (Recommended value). The maximum number of concurrent requests is 50. A high number of concurrent requests means that the backup will run faster. However, it will add more load on your server. Once the setup is complete, you can run the following test command to make sure it all works fine. dms-backup.exe test The command runs a backup for a small number of files. If there is an issue during the backup, please contact RedEye for support. Just RedEye It. Page 6 of 8

7 When the tests pass, you can run the following command to install the backup solution as a service. This will create a new service in the Windows Service Manager: dms-backup.exe install Nothing will be printed out on success. In the case of a failure, an error message will be printed out, and application event logs should be created and viewable in your event log viewer. You can now start the service in your Windows Service Manager. The name of the service is RedEye Backup Service, and is set to automatically run when the system starts. To start the service, select it, and either click on the green Start icon in the tools bar, or right click on the service and click Start. Just RedEye It. Page 7 of 8

8 6. EVENT LOGS The backup solution logs events that can be viewed in Windows Event Viewer. The event source name is redeye-dms-backup. The backup solution logs events when a backup is being processed, or when errors occur during installation or a backup. Here is the list of all available events and their code: Event Name Event ID ErrorConfig 1 ErrorPermissions 2 WarningSchedule 3 EventServiceInstalled 100 EventServiceUninstalled 101 EventServiceStarted 102 EventServiceStopped 103 EventServicePaused 104 EventBackupStarted 200 EventBackupDirStarted 201 EventBackupCompleted 202 EventBackupDirCompleted 203 EventBackupSkipped 204 EventBackupFailed 210 ErrorInstallingService 300 ErrorUninstallingService 301 ErrorStartingService 302 ErrorStoppingService 303 ErrorPausingService 304 ErrorAWSCredsInvalid 400 ErrorAWSConnect 401 ErrorAWSOther 402 RedEye Apps Brisbane Houston Palo Alto