Initial Configuration on NAS
This article will guide you through the initial configuration of CubeBackup on a TerraMaster NAS. If you are using a NAS from other vendors, you can use this article as a reference.
1. Start the CubeBackup configuration wizard
After CubeBackup has been successfully installed, it will appear on the desktop of TOS. You can start to configure CubeBackup by clicking the CubeBackup icon on the desktop.
- CubeBackup starts a web service on port 8762 on the NAS, so you can also access or configure CubeBackup by visiting http://<nas-ip>:8762 on any web browser within your network.
- A NAS with at least 2GB memory is recommended to run CubeBackup. CubeBackup may run into an “Out of memory” issue if the NAS has less than 2GB RAM.
- By default, CubeBackup is installed in the ”/usr/local/cubebackupgsuite” directory on TerraMaster NAS.
2. Set backup location
First, you need to set the backup directories for G Suite data.
NOTE: Please ensure your NAS has enough available space to store all employee data in your G Suite domain, including any future backups. Because Google does not always report the size of all files stored and does not even count some files when totaling storage, and since CubeBackup itself keeps a revision history of files, a good rule of thumb is reserve 2x the estimated data size for your domain. For example, if there are 100 users in your G Suite domain and each user has 10GB of data on average, there should be at least 100 * 10GB * 2 = 2TB of space available on your NAS.
Data index path: For performance reasons, CubeBackup needs to keep some metadata on a separate directory when backing up G Suite data.
TIP: Data index is the metadata for the backups, and its accessing speed is crucially important for the performance of the backups. If there is an SSD installed on your NAS, you should place the data index data on the SSD . More information can be found at What is the data index.
Backup path: Select a directory on NAS for the G Suite backup data.
TIP: The “/mnt” directory is the mount point for hard drives, so in most cases, you should store backups in a subdirectory under “/mnt”.
Encrypt backups: If you want your backups to be stored encrypted, make sure the “Encrypt backups” option is checked.
Tips for Backup Encryption:
- This option cannot be changed after the initial configuration.
- Data transfer between the Google Cloud and your storage is always HTTPS/SSL encrypted, whether this option is selected or not.
- Encryption may slow down the backup process by around 10%, and cost more CPU cycles.
When all information has been entered, click Next to continue.
3. Create Google Service account
In step 3, you are required to input the G Suite domain name, the domain administrator account, and the Service account key file.
What is the Service account key? Why is it needed?
Basically, a service account is a special Google account that is used to call Google APIs, so that users don’t need to be directly involved. Refer to https://cloud.google.com/iam/docs/service-accounts for more information.
To generate the Service account key file, please follow the instructions below:
3.1 Log in to Google Cloud Console.
Google Cloud Console does not require an administrator account. A personal Google account, such as firstname.lastname@example.org, or email@example.com is just fine.
3.2 Create a new project named “CubeBackup”.
Google Cloud Console is a place to manage applications/projects based on Google APIs or Google Cloud Services. Begin by creating a new project.
- Go to the Projects page in the Google Cloud Console.
TIP: This page can be opened by either clicking the above link or selecting IAM & admin > Manage resources in the navigation menu. The navigation menu slides out from the left of the screen when you click the icon in the upper left corner of the page.
Click CREATE PROJECT.
In the New Project page, enter “CubeBackup” as the project name and click CREATE.
TIP: You can leave the Location and Organisation fields unchanged. They have no effect on this project.
3.3 Enable Google APIs.
The creation of the project may take one or two minutes. After the project has been created, click the SELECT PROJECT link for the newly created project in the Notifications dialog to make it the active project in your dashboard (you can also go to the Home dashboard by selecting Home from the navigation menu, then select your newly created project in the project list at the top of the page).
NOTE: Please make sure this project is the currently active project in your console before continuing!
Now open the API Library page by selecting APIs & services > Library from the navigation menu. Select Google Drive API from the G Suite group. On the next page, click ENABLE. Next, go back to the API Library page and follow the same steps to enable Google Calendar API, Gmail API, Admin SDK, and Google People API (this API might be located in the Social Group).
To check whether all necessary APIs have been enabled, please select APIs & Services > Dashboard from the navigation menu, and make sure Admin SDK, Gmail API, Google Calendar API, Google Drive API, and People API are all included in the API list.
3.4 Create a Service account.
- Select IAM & Admin > Service Accounts in the navigation menu.
- Click +CREATE SERVICE ACCOUNT.
- In the Service account details step, enter a name for the service account (e.g., cubebackup) and click CREATE.
- In the next step, select “Project” > “Viewer” as the Role, then click CONTINUE.
- Click DONE directly in the Grant users access to this service account step.
- On the Service accounts page, click directly on the service account you just created (Don’t just check the box, click the email link). This should take you to the Service account details page.
- In the Service account details page, click EDIT, then expand SHOW DOMAIN-WIDE DELEGATION and check Enable G Suite Domain-wide Delegation. If you are asked, enter “CubeBackup” as the Product name for the consent screen.
- Click SAVE.
- Click ADD KEY > Create new key on the Keys section.
- Select JSON as the key type, then click CREATE.
- Close the dialog that pops up and save the generated JSON key file locally (This file will be used as the service account key in CubeBackup’s configuration wizard).
- In the end, your service account page should approximately look like this:
3.5 Return to the CubeBackup setup page
After the Service account key file has been generated and downloaded to your local computer, click the Choose File button to select the JSON key file generated in the last step. After the domain name, the G Suite administrator account, and the service account key file are all set, click Next
4. Authorize domain-wide access
After creating a Google service account, the created service account needs to be authorized to access your G Suite data through Google APIs.
All operations in this step must be performed by an administrator of your G Suite domain.
- Sign in to your G Suite domain’s Admin console using a domain administrator account.
- From the main menu in the top-left corner, select Security > API controls.
- Click MANAGE DOMAIN WIDE DELEGATION in the “Domain wide delegation” section.
- In the Domain-wide Delegation page, click Add new.
- In the Client ID field, enter the service account’s Client ID shown in step 4 of the setup wizard.
In the OAuth Scopes field, copy and paste this list of scopes:
https://www.googleapis.com/auth/admin.directory.domain.readonly, https://www.googleapis.com/auth/admin.directory.user.readonly, https://www.googleapis.com/auth/admin.directory.orgunit.readonly, https://mail.google.com/, https://www.googleapis.com/auth/drive, https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/contacts, https://sites.google.com/feeds/
CubeBackup now has the authority to make API calls in your domain. Return to the CubeBackup setup page, and click the Next button to check if these configuration changes have been successful.
NOTE: If any error messages pop up, please wait a few minutes and try again. In some cases, G Suite domain-wide authorization needs some time to propagate. If it continues to fail, please recheck all your inputs and refer to How do you solve the authorization failed error.
5. Select users
Now you can select which G Suite users you would like to back up.
- By default, all valid users are selected.
- You can expand an Organization Unit by clicking the OU to see users in that OU.
- You can even disable the backup for all users in an OU by deselecting the checkbox beside that OU.
For example, if a school wanted to backup only the data for teachers and not students, they could select the OU for teachers and leave the OU for students unchecked.
6. Select Shared drives
This step only applies to G Suite Business/Enterprise/Education/Nonprofit organizations who have the Shared drives feature enabled. For G Suite Legacy or G Suite Basic organizations, this step will be skipped.
You can select which Shared drives you would like to back up.
- By default, all shared drives are selected.
- This can be very useful for schools. For example, an administrator may not want to backup shared drives created by students, which could consume a very large amount of storage.
7. Set administrator password
In this step, you can set up the CubeBackup web console administrator account and password.
This account and password is only for the CubeBackup console; it has no relationship with any G Suite services.
The default administrator account is the G Suite administrator of your organization, but this is not required. You can make anyone the CubeBackup administrator.
Multiple administrator accounts are not supported by the current version of CubeBackup.
8. More settings
After the initial configuration of CubeBackup, you can log into the CubeBackup web console and select SETTINGS on the left panel for more options. There are two tabs on this page.
The first tab affects only the selected domain; the second tab controls global system settings.
G Suite domains management
As a G Suite administrator, you may manage more than one domain. G Suite Partners/Resellers in particular are often responsible for managing many domains for their clients. CubeBackup allows you to manage multiple domains in one place.
You can select the active domain or add a new domain from the drop-down box in the top-right corner of the web console.
- Adding a new G Suite domain
You can add a new G Suite domain to CubeBackup by clicking + add domain from the drop-down list in the top-right corner of the web console.
On the Add domain screen, enter the G Suite domain name and admin account for the domain you wish to add, then click Next.
Follow the instructions on the next screen to paste the required Service account Client ID and OAuth Scopes into the G Suite admin console. Once the OAuth Scopes have been authorized, click Next.
Now, select the users to backup for the new domain.
- By default, all valid users are selected.
- You can expand an Organization Unit by clicking the OU to see users in that OU.
You can even disable the backup for all users in an OU by deselecting the checkbox beside that OU. For example, if a school wanted to backup only the data for teachers and not students, they could select the OU for teachers and leave the OU for students unchecked.
Finally, click Save.
Backups for an entire G Suite domain can be quite large, and the backup process can consume considerable network bandwidth. CubeBackup allows you to flexibly control network throttling by setting speed limits for work hours and non-work hours independently. Both work days and work hours can be defined to meet your company’s unique needs.
As an administrator, you may not want to constantly sign in to the CubeBackup web console to check the status of the backup service. CubeBackup can send you monthly, weekly, or even daily email reports of backup status, progress, space used, and much more.
For convenience, CubeBackup will send the email reports to recipients using firstname.lastname@example.org by default. These reports are generated locally by your backup machine. All details and statistical data used to generate the reports remain private. However, if you wish, you can set up your own SMTP server for these reports.
Purchase a license
CubeBackup is free for trial for 14 days. After the trial period, you must purchase a license to keep using CubeBackup to secure your G Suite data.
On the OVERVIEW page in CubeBackup web console, click the Purchase license link in the license information section to be directed to the subscription page, where you can purchase a license for CubeBackup.
- For G Suite Basic/Business/Enterprise organizations, the price is $5 USD/user/year.
- For G Suite Education/Nonprofit organizations, the price is $2 USD/user/year.