Comet Backup
Learn how to use Comet Backup to store backups on the ScPrime distributed datacenter using the XNS Relayer
Overview
Comet Backup is an enterprise-grade white label software solution used to manage backups from a central location. Comet is a great solution for MSP’s or consultants providing managed backup services to their customers and clients. Comet can be used as a pure SaaS solution however its true potential lies in its capability to run as a self-hosted solution and pairs nicely with XNS storage.
Read this guide for how to configure Comet to backup to XNS.
Prerequisites
- Install and patch Linux. Note: Ubuntu was used to create this guide, however most top tier Linux distributions should work well. Additionally, all software referenced in this guide has a Windows compatible version
- Install and configure ScPrime’s XNS Relayer v2.0.0 or later – follow this guide: XNS Relayer Setup Guide
- Install Comet’s self-hosted server on the same server as the XNS Relayer – follow this guide: Comet Installation Guide
- Configure the XNS Relayer’s “Endpoint Access Key (Username)” and “Endpoint Secret Key (Password)”
Considerations
- This guide does not cover security configuration and assumes the reader is knowledgeable and capable of applying security best practices to ensure the environment and underlying data are safeguarded.
Application Version Used in Guide
Self-hosted Comet Server 23.2.0 ‘Leda’
Guide Revision Date
2023-03-28
Setup Guide
Step 1: Configure the XNS Relayer Certificate
Navigate to the XNS Configuration menu. Go to the setting “Select Endpoint Certificate Type” and select “No SSL”. (Note: Start with no certificate to make it easier to verify the setup is working properly. After completing this guide and the setup is working, this setting can be changed as required):
Step 2: Configure the XNS Relayer Bucket
Go to MinIO (by default: http://localhost:9000) and create a test S3 bucket. Make sure the bucket has a “Read and Write” policy set by selecting the ellipsis menu (…) next to the bucket name:
Change “Read Only” to “Read and Write” and click Add:
Step 3: Login to the Comet Server
Configure the Comet Server to take advantage of ScPrime’s distributed datacenter by going to the Comet Admin Portal: http://localhost:8060 (by default, the Comet Server listens for connections on 127.0.0.1 port 8060). Login to the Comet Admin Portal. If this was a fresh Comet install, the default username and password is “admin” for both:
Step 4: Configure Comet Storage to S3-compatible
Navigate to the Comet Server settings:
Select “Storage”:
Ensure the Storage Role is enabled for the server:
1) Under “Locations”, click the “+” (plus symbol)
2) Select “S3-compatible”
3) Click Save:
Step 5: Configure Comet S3-compatible Storage Settings
Configure the S3-compatible settings but do not save or click “Test Connection” just yet:
| Hostname: | http://localhost:9000 | Select http:// in the drop-down and enter localhost:9000 (port needs to match the XNS Relayer – 9000 is the default). Make sure the XNS Relayer is using “No SSL” as stated earlier in this guide. The setting may be changed later after the configuration is confirmed working |
| Region: | Leave as the default “Automatic” | |
| Access Key: | [Your Access Key] | This is defined in the XNS Relayer setting “Endpoint Access Key (Username)” |
| Secret Key: | [Your Secret Key] | This is defined in the XNS Relayer setting “Endpoint Secret Key (Password)” |
| Bucket: | [Your Bucket] | Enter the bucket name created in MinIO (this was part of the XNS Relayer Setup) |
| Subdirectory: | Can be left as the default | Leave as the default “backup-data” which will create a new subfolder under the bucket
|
Step 6: Confirm and Save the Comet S3-compatible Settings
Caution: Double-check the above settings are accurate before saving changes and before clicking “Test Connection”. If any of the settings are configured incorrectly, or if there is a misconfiguration issue (e.g. Comet cannot access the S3 bucket), the Comet Server service/listener may stop, and access to the Comet web portal will be lost until the issue is resolved. According to Comet, this behavior is by design – the service does not start if it cannot reach the configured storage location.
Note: Under the “Locations” section, there is a “Replication” section. Comet has a feature that allows data replication to other Comet servers. This Comet feature may be unnecessary due to the built-in redundancy of XNS Storage and highlights one of the differentiating features of ScPrime’s distributed datacenter. Data redundancy can be fine-tuned in the XNS Relayer giving the administrator granular control.
After confirming all the settings are correct, click “Save Changes” at the top right of the screen:
Step 7: Final Steps
The final steps will not be covered in this guide in detail as the Comet documentation is extensive. That said, add a few test user accounts and configure them to use the Storage that was configured in this guide. Once everything is working properly, go back and add SSL Certificates to the XNS Relayer if needed. However, this may not be necessary as the traffic between Comet and the Relayer are localized when configured as specified in this guide. Finally, the Comet server should be configured with a domain name and https:// over port 443 so the client backup software can communicate securely with the Comet server.
“Replication” section. Comet has a feature that allows data replication to other Comet servers. This Comet feature may be unnecessary due to the built-in redundancy of XNS Storage and highlights one of the differentiating features of ScPrime’s distributed datacenter. Data redundancy can be fine-tuned in the XNS Relayer giving the administrator granular control.
After confirming all the settings are correct, click “Save Changes” at the top right of the screen:
