AvePoint Docs
Graph API
My support tickets
Graph API
My support tickets
English

Home > Manage CAP Gateways > Install a CAP Gateway

Export to PDF

Install a CAP Gateway

After creating a CAP Gateway in Cloud Backup for IaaS + PaaS, you need to install the gateway in your cloud environment. Before installation, note the following:

- For Google VM instance, the gateway must be installed on a VM instance within the same project as the protected instances configured in the backup scope. - For Azure VM and Azure Storage, the gateway must be installed on a VM within the same tenant as the protected VMs/blob containers/file shares configured in the backup scope. - It’s recommended to install the gateway in the same zone/region as the protected instances configured in the backup scope for optimal performance. - The instance where the gateway is installed should run **Ubuntu Server 24.04 LTS - x64** as its operating system, with a recommended machine type of 4 CPU cores and 16GB of memory. - For better performance, you can use different gateways for different backup scopes and use multiple gateways for one backup scope as needed.

Follow the steps below to install the CAP Gateway:

  1. Select a gateway and click Get package.

  2. In the Get package panel, follow the steps below:

    1. In the Get package step, copy the SAS URL for package to your clipboard.

    2. Locate the Google VM instance/Azure VM/Azure Storage VM where the gateway will be installed, then execute the following wget command to download the installation package to your instance/VM. Replace ‘CAPGateway_SerialNumber.tar.gz’ in the command with the actual downloaded package name and replace ‘sas url’ with the SAS URL copied in the Get package step.

      wget -O CAPGateway.tar.gz "{package sas url}"

      *Note: The ‘O’ in the command is the uppercase letter 'O', not the number zero '0'.

    3. In the SAS URL for configuration file/Signed URL for configuration file step, copy the passphrase and URL for the configuration file to your clipboard.

      • To protect Microsoft Azure service, copy the SAS URL and passphrase to your clipboard.

        Copy the SAS URL and passphrase.

      • To protect Google Cloud service, copy the Signed URL and passphrase to your clipboard.

        Copy the Signed URL and passphrase.

  3. After downloading, execute the following command line to extract the package contents to the ./cap directory.

    sudo tar -xzf CAPGateway.tar.gz -C ./cap

    *Note: Before running the command, ensure the ./cap directory exists. You can verify its existence with the following command:

    mkdir -p./cap

  4. Execute the following command line to grant permissions for the install sh.script included in the extracted package:

  5. sudo chmod +x ./cap/install.sh

  6. Execute the following command line to run the install.sh script. Replace ‘passphrase’ and ‘url for configuration file’ in the command with actual values copied from the Get package panel.

    sudo ./cap/install.sh -p "passphrase" -s "url for configuration file"

    • To protect Microsoft Azure service, replace ‘url for configuration file’ with the SAS URL for configuration file copied from the Get package panel > SAS URL for configuration file step.

    • To protect Google Cloud service, replace ‘url for configuration file’ with the Signed URL for configuration file copied from the Get package panel > Signed URL for configuration file step.

Update a CAP Gateway

If you need to update your CAP Gateway configurations, such as the passphrase and url for configuration file, you can execute the following command. Replace ‘passphrase’ and ‘url for configuration file’ in the command with actual values copied from the Get package panel.

sudo ./cap/install.sh -p "passphrase" -s "SAS url" -c

- To protect Microsoft Azure service, replace ‘url for configuration file’ with the SAS URL for configuration file copied from the **Get package** panel. - ![Copy the SAS URL and passphrase.](/en/iaas-paas/manage-cap-gateways/images/image56.png "Copy the SAS URL and passphrase.") - To protect Google Cloud service, replace ‘url for configuration file’ with the Signed URL for configuration file copied from the **Get package** panel. - ![Copy the Signed URL and passphrase.](/en/iaas-paas/manage-cap-gateways/images/image57.png "Copy the Signed URL and passphrase.")

Verify Checksum

After downloading the installation package, you can run the following command to verify its checksum. Compare the result with the hash value displayed in the Get package panel to ensure the checksum is correct. Replace ‘CAPGateway_SerialNumber.tar.gz’ in the command with the actual downloaded package name

sudo sha256sum ./CAPGateway_SerialNumber.tar.gz

Uninstall a CAP Gateway

If you want to uninstall the CAP Gateway, locate the unzipped package folder, and execute the following command lines:

  1. sudo chmod +x ./cap/uninstall.sh

  2. sudo ./cap/uninstall.sh