Software Configuration¶

Configuration steps¶

1. File -> Open Connection

2. Select “OpenStack Swift (Keystone 3) in the top drop down.

3. Server: select a “identity” URL from Application programming interfaces (APIs) and enter only the server name, e.g.: api.nz-por-1.catalystcloud.io

4. Port: 5000

5. Project:Domain:Username: Enter you project name, “default”, and your username, .e.g: example-com:default:operations@example.com

6. Password: enter your password

7. Click “Connect”.

This doesn’t save the connection details, so if you connect okay, you’ll want to add a bookmark, to do this:

1. Bookmark -> New Bookmark

2. Nickname: Enter a suitable nickname

3. You can set the default folder on your local computer here as well.

4. Click the little x on the top bar of the window.

Prerequisites:¶

The following is a list of prerequisites that you will need to have before you can begin configuring Duplicati to work with our object storage service.

• You already have an object storage container ready to receive and store your backup data.

• You have a user account that is able to interact with the object storage service. (For purposes like backups we recommend that you use a dedicated user that only has the object storage role for permissions)

Configuration steps¶

Once you have your prerequisites sorted, you can follow these steps to get your Duplicati backups sent to your object storage container:

1. Use Menu -> Add Backup.

2. Ensure ‘Configure a new backup’ is selected, go Next.

3. Configure General backup settings. It is a good idea to use encryption for you backups, but it isn’t required.

4. Configure Backup Destination:

   1. Storage Type: Select: Backup Object Storage / Swift

   2. Bucket name: [Enter the name of your container]

   3. OpenStack AuthURI: Select an identity API URL from Application programming interfaces (APIs). If you are using single region replication, please select the identity API URL for the region your container is within.

   4. Keystone API version: Select: v3

   5. Domain Name: Enter: “default”

   6. Username & Password: The account credentials you would like to use.

   7. Tenant Name: [Enter the project name where your container is]

5. Source Data: Select the paths and/or files to backup.

6. Schedule: Set the desired schedule.

7. Options: You should be fine to leave the defaults.

Once this is complete you should see your backups start to appear in your selected object storage container.

Configuration steps¶

1. Accounts -> Add new account

2. Account type: select “S3 Compatible Storage”

3. REST Endpoint: select a “s3” URL from Application programming interfaces (APIs)

4. Access Key & Secret Access Key: EC2 credentials (you may wish to create a dedicated user).

5. Select “advanced settings”

6. Signature version: select “Signature V4”

7. Select “Close”

8. Select “Add new account”

You should now be able to connect to the account and then browse, upload, download etc. You may occasionally receive errors that some functionality isn’t supported.

Configuration changes¶

The following changes need to be specified in the .s3cfg file. You can select the appropriate API endpoint from the API page.

s3cmd needs to use signature v2 as we’ve observed that it has a compatibility issue when communicating with our S3 interface using the default of signature v4.

host_base = object-storage.nz-por-1.catalystcloud.io:443
host_bucket = object-storage.nz-por-1.catalystcloud.io:443
signature_v2 = True
use_https = True

Compatibility with S3¶

Please refer to the Object Storage section of the OpenStack Swift documentation for an in depth explanation of the compatibility to S3 APIs.

A tutorial is also covered in the Catalyst Cloud documentation here.

Setup¶

After installing the “Hyper Backup” package from the Synology Package Center, the following steps are needed to enable backups of your NAS to our object storage service:

1. Open “Hyper Backup” from the applications menu (top left button of the main NAS page)

2. Click the “+” button in the top left of the Hyper Backup window.

3. Select which type of backup you want, either are supported.

4. For Data backups:

   1. Select “Openstack Swift” from the list of backup destinations and click “Next”

   2. On the next page:

      1. For “Identity Service endpoint” enter “https://api.nz-por-1.catalystcloud.io:5000/v3”

      2. For “Identity Service version” select “3.0” from the drop-down

      3. Enter your Catalyst Cloud username and password in the appropriate boxes

      4. For “Tenant/Project” choose “id” from the drop-down, and then enter the project ID where objects will be stored. You can find the project ID from the Catalyst Cloud dashboard under Identity and then Projects.

      5. For “Domain”, choose “id” from the drop-down and enter “default”

      6. You should now be able to select a Catalyst Cloud region from the “Location” drop down.

      7. You can select an existing object container from the “Container” drop-down, or create a new one in the same drop-down

      8. “Directory” can be left as the default generated by the NAS.

      9. Click Next

   3. Select the volumes you wish to back up, and click “Next”

   4. Select the Synology applications you want backed up, and click “Next”

   5. Lastly, you can give the backup job a name, and set the backup schedule. Then click “Next”

   6. The next page will allow you set a backup rotation. Click “Done” when complete.

   7. You will be promoted if you want to perform a backup now.

Using single-region object containers¶

By default, containers created by your Synology NAS in the above process will use our multi-region replication mode. This is generally recommended for backups.

However, if you would prefer single-region object storage, you will need to create the object container in our dashboard first using this policy, and then select that container in the process above rather than creating a new container.

Note: ensure you select the same region you created the object container in when selecting the location in the steps above.

Restoring backups¶

Hyper Backup includes a “Backup Explorer” that can restore files and settings from backups you have in our object storage service.

Consult the Synology documentation for more information on how to restore backups.

Setup¶

After installing the “Cloud Sync” package from the Synology Package Center, the following steps are needed to add a backup or sync to our object storage service:

1. From the applications menu (top left) open Cloud Sync

2. Press the “+” button in the top left of the Cloud Sync pane to add a new target.

3. In the list of Cloud Providers, select “OpenStack Swift” and click “Next”.

4. Enter the following details:

   1. For “Identity Service endpoint”, enter “https://api.nz-por-1.catalystcloud.io:5000/v3”

   2. For “Identity Service version”, select “3.0” from the drop-down

   3. Enter your cloud username and password in “Username” and “Password”

   4. For “Tenant/Project” choose “id” from the drop-down, and then enter the project ID where objects will be stored. You can find the project ID from the Catalyst Cloud dashboard under Identity and then Projects.

   5. For “Domain”, choose “id” from the drop-down and enter “default”

   6. Click “Next”

5. If your credentials are correct, you will be asked now for a location and container name. “Location” chooses which cloud region the objects will be stored in. “Container Name” allows you to select an existing object storage container, or create a new one. You’ll need to enter both of these values before hitting “Next”

6. In the next page, the settings provided are:

   1. “Connection name” is a name you’ll see for this backup on your NAS.

   2. “Local Path” is the directory on your NAS you want backed up.

   3. “Remote Path” can set left as “Root folder”. We do not recommend sending multiple backups in different folders to the same object container.

   4. “Sync direction” can be any of the settings. For a backup, we recommend “Upload changes only”

   5. “Part size” must be a minimum of 128MB, however we support any size up to 5GB.

   6. For backups, we recommend ticking the option “Don’t remove files in the destination folder when they are removed in the source folder”, this means that you can restore deleted files from your NAS by copying them from the object storage service.

   7. For other options, please consult Synology DSM documentation.

   8. Note: enabling data encryption may prevent restoring individual files.

7. Once clicking Next, you’ll be able to confirm the settings and enable the sync.

Using single-region object containers¶

By default, containers created by your Synology NAS in the above process will use our multi-region replication mode. This is generally recommended for backups.

However, if you would prefer single-region object storage, you will need to create the object container in our dashboard first using this policy, and then select that container in the process above rather than creating a new container.

Note: ensure you select the same region you created the object container in when selecting the location in the steps above.

Restoring deleted files¶

The Synology NAS has no built-in interface to restore files, however this can be done by downloading the deleted files from the Catalyst Cloud dashboard. You can browse and download files stored directly from the dashboard.

Note: If you have enabled “Data Encryption”, you will not be able to restore files with this method.

Configuration steps¶

1. New site

2. File protocol: Amazon S3

3. Host name: select the appropriate “s3” endpoint from the API page.

4. Access Key & Secret Access Key: EC2 credentials (you may wish to create a dedicated user).