Installing Veeam Backup for Salesforce

You can install Veeam Backup for Salesforce automatically using the installation script or manually.

Installing Product Using Script

To install Veeam Backup for Salesforce, complete the following steps:

  1. Download the installation script to the machine where you want to deploy Veeam Backup for Salesforce. To do that, run the following command:

sudo curl https://repository.veeam.com/yum/el/vbsf-install-script.sh --output ./vbsf-install-script.sh

  1. Run the script:

sudo sh ./vbsf-install-script.sh

Veeam Backup for Salesforce will start installation of packages and dependencies, configure all settings, and then run configuration checks.

  1. Copy to the automatically generated URL and paste it into a web browser to proceed with the initial configuration of Veeam Backup for Salesforce.

Important

By default, the URL contains an IP address of the management server. If the specified IP address is not available over HTTPS, replace it with the public IP of the management server or the DNS name configured for the machine where the Veeam Backup for Salesforce is installed.

Installing Product Manually

To install Veeam Backup for Salesforce, complete the following steps:

  1. Download the Veeam software repository installation package (veeam-release) from the Veeam Download page to the machine where you want to deploy Veeam Backup for Salesforce

sudo curl http://repository.veeam.com/yum/el/veeam-repo-1.0.1-6.x86_64.rpm --output veeam-repo.rpm

  1. Install repository and a package manager. To do that, run the following command:

sudo yum install veeam-repo.rpm

  1. Install the product using the package manager from the repository. To do that, run the following command:

sudo yum install vbsf

Veeam Backup for Salesforce will start installation of packages and dependencies, and then run configuration checks.

  1. After all configuration checks complete successfully, you will be prompted to run the server configuration script. To do that, run the following command:

sudo sh /opt/vbsf/server-configuration.sh

To complete server configuration, do the following:

  1. Confirm that you have enough disk space to store backup data.

Note

To store backups of Salesforce binary objects and metadata, Veeam Backup for Salesforce will create a file repository per each protected Salesforce organization on the management server in the following folder /opt/vbsf/vbsf-backup/data.

  1. Configure log rotation settings.

At this step the log rotation policy must be configured. This policy defines a time period during which the logs will be kept. It allows you to consume less storage space by deleting product logs that are no longer needed.

The time period is specified in days. If you specify 0, product logs will not be deleted. Consider that if the management server runs out of space, Veeam Backup for Salesforce will fail to run.

  1. Choose whether you want to install a PostgreSQL instance on the management server.

When installing PostgreSQL locally on the management server, Veeam Backup for Salesforce will run the installation script and create two users: the postgres user — the root database user, and the vbsf user — the local user. The vbsf user will be automatically provisioned into the default application configuration.

User credentials will be automatically generated and saved to the /opt/vbsf/vbsf-backend/vbsf_default_credentials.properties file. If you change the created passwords using the PostgreSQL standard methods, the passwords stored in the file will not automatically change and will become invalid.

Note

You may want to install PostgreSQL locally on the management server to host the configuration database which will help you avoid connectivity issues. It is recommended to create databases that will be used to protect production and sandbox Salesforce organizations on remote PostgreSQL servers. Creating the databases on the management server may cause disk space issues.

  1. Choose whether you want to automatically configure Nginx settings required for the management server to work properly.

It is recommended to allow Veeam Backup for Salesforce to configure Nginx automatically. To learn how to configure Nginx manually, see this Veeam KB article.

After the automatic Nginx configuration completes, Veeam Backup for Salesforce displays the web address that will be used to launch the initial configuration wizard. The address contains an IPv4 address of the server and a token used to authorize the user access.

Tip

If you accidentally close the terminal or the connection session during installation, or if you configure Nginx manually, you can find the web address URL in the /opt/vbsf/access_token.txt file on the machine where Veeam Backup for Salesforce is installed.

  1. Copy to the automatically generated URL and paste it into a web browser to proceed with the initial configuration of Veeam Backup for Salesforce.

Important

By default, the URL contains an IP address of the management server. If the specified IP address is not available over HTTPS, replace it with the public IP of the management server or the DNS name configured for the machine where the Veeam Backup for Salesforce is installed.