Creating A Backup
The Backup module lets you back up the files and database of ISL Conference Proxy, run backups manually or on a schedule, and restore a server from an existing backup, for example when migrating to a new machine. All backup settings are managed from the ISL Conference Proxy administration page.
- Access the backup pages
- Create a new backup
- Make a backup
- Edit a backup
- Remove a backup
- Get information on a failed backup
- Restore a backup
Access the backup pages
Follow the steps below to open the backup pages.
Step 1
Log in to the ISL Conference Proxy administration page.
Step 2
Click "Backup(s)" under "Configuration" to open the backups page.
If this is the first time you are visiting the backup pages, you will see no backups. See Create a new backup for instructions on how to create one.
Create a new backup
Follow the steps below to create a new backup of ISL Conference Proxy.
Step 1
In the backup pages click "Create New Backup".
Step 2
Enter the name of the backup.
Note: This field is mandatory. "Backup name" must be shorter than 1024 characters and must be unique, meaning no two backups can have the same name.
Step 3
Select which server to back up, in case multiple servers are available.
Note: 1 means that the backup will be created for server 1 if you have multiple ISL Conference Proxy servers.
Step 4
Enter the full path where the backup should be created.
Important: It is crucial that the location where you want to save the backup files is accessible and readable by ISL Conference Proxy, which runs as the user islcp. islcp does not have administrative rights (administrator or local system account on Windows, root on Linux), so we suggest using a top level directory (e.g. C:\icp-backup on Windows or /icp-backup on Linux) and adjusting its permissions appropriately.
Important: The directory specified must exist and the islcp user must have write permissions for it. If you get the error "Could not set backup directory at the specific location. Directory "<path>" is not empty", open the folder properties and under the "General" tab uncheck the box in front of "Read-only (Only applies to files in folder)".
Depending on the configuration, the islcp user might have to be added to the "Security" tab of the folder with read/write permission, including all directories on the specified path.
On Linux, you have to change the owner of the directory to islcp. Run the following command in your terminal to change the ownership:
sudo chown islcp <path>
Note: This field is mandatory. "Path on disk" must be shorter than 1024 characters.
Step 5
Select the hour, minute and day of the week for the backup to start automatically. If you leave it unchecked, you will still be able to start the backup manually.
Step 6
Select what you want to back up: "Files", "Database" or both. Select both if this backup will be used to migrate the server.
Step 7
Enter the e-mail addresses that will receive a notification when a backup is finished (not mandatory). You can enter multiple addresses by separating them with a comma.
Step 8
Click "Create" to add the backup. You will be redirected to the overview dashboard, where the new backup is shown.
Make a backup
Follow the steps below to run a backup manually.
Step 1
Go to the backup pages and click "Backup Now" next to the backup location you want to back up.
Step 2
When the backup is finished, a new entry appears in the Backup history, together with its status (ok/failed) and the time it finished.
Edit a backup
Follow the steps below to edit an existing backup.
Step 1
Go to the backup pages, click the arrow next to the backup you want to edit and click "Edit Backup".
Step 2
A new page opens, identical to the one used to create a backup. Follow the instructions in Create a new backup, continuing from Step 2.
Remove a backup
Follow the steps below to remove an existing backup.
Step 1
Click the arrow next to the backup you want to delete and click "Remove Backup".
Step 2
Click "Remove" to confirm the deletion of the backup.
Get information on a failed backup
Failed backups have an exclamation mark next to them. Click it to display a message describing what went wrong.
Restore a backup
Note: There is a known bug in version 4.4.1917.33 of ISL Conference Proxy where the backup fails to restore if the version of the backup and the current ICP are the same. In newer versions the backup is restored correctly. If you are experiencing issues, please upgrade ICP to a newer version or contact our support and we will provide you with a workaround.
Follow the steps below to restore ISL Conference Proxy from an existing backup. Make sure to transfer the backup files to the machine where you intend to perform the restore before proceeding.
Step 1
Windows
- Download the latest ISL Conference Proxy installer (choose the 32-bit or 64-bit version, depending on your operating system). Most machines nowadays are 64-bit, so the examples use the 64-bit version; modify accordingly for 32-bit.
- Run the ISL Conference Proxy installer and follow the installation wizard. When prompted, enter the path to the location where you placed the backup files. Make sure you read the important note below.
Important: It is crucial that the full path of the location where you placed the backup files is accessible and readable by ISL Conference Proxy, which runs as the user islcp (not as administrator or local system account). We therefore suggest using a top level directory (such as C:\icp-backup) and adjusting its permissions appropriately.
The provided location must also include the backup directory marker (a file called _islcp_backupdir_). If you only have the .gz files and the files with their checksums, you can use the echo command to create the marker, e.g.:
echo . > C:\icp-backup\_islcp_backupdir_
Linux
- Download the latest ISL Conference Proxy installer (choose the 32-bit or 64-bit version, depending on your operating system). Most machines nowadays are 64-bit, so the examples use the 64-bit version; modify accordingly for 32-bit.
-
32-bit: https://www.islonline.com/system/installer_latest_linux
wget http://www.islonline.com/system/installer_latest_linux
-
64-bit: https://www.islonline.com/system/installer_latest_linux64
wget http://www.islonline.com/system/installer_latest_linux64
-
-
Log in as root and install ISL Conference Proxy (replace /icpbackup with the location where you placed the backup files; make sure you read the important note below):
sh installer_latest_linux64 restorebackup /icpbackup
Important: It is crucial that the full path of the location where you placed the backup files is accessible and readable by ISL Conference Proxy, which runs as the user islcp (not as root). We therefore suggest using a top level directory (such as /icpbackup) and adjusting its permissions appropriately.
The provided location must also include the backup directory marker (a file called _islcp_backupdir_). If you only have the .gz files and the files with their checksums, you can use the touch command to create the marker, e.g.:
touch /icpbackup/_islcp_backupdir_
Note: By default, the temporary folder for restoring an ISL Conference Proxy backup is /tmp/. You can set a custom temporary location if needed. As an example, we create a confproxyrestore directory in /opt/ and set it as an environment variable:
mkdir -p /opt/confproxyrestore export TMPDIR=/opt/confproxyrestore sh installer_latest_linux64 restorebackup /icpbackupThe ISL Conference Proxy installer now uses /opt/confproxyrestore as the temporary directory instead of /tmp/. When the restore procedure is completed, you can remove the /opt/confproxyrestore directory.
Step 2
After the installer has finished, log in to your ISL Conference Proxy administration (<icp_server_address>/conf) and click "Online update".
Step 3
Click "Restore".
Step 4
Click "Restart ISL Conference Proxy" to finish the restore procedure.
Step 5
After ISL Conference Proxy is back up and running, perform a quick check of the restored state:
1. If you see errors at the top of the administration page such as "Failed to load module postgresql_...", there was probably a directory permission issue and ISL Conference Proxy was unable to access the specified backup directory to perform the restore.
2. Check "User management" to see that the expected domains and users are present.
3. Perform a product login with one of the users and check that the expected computers are listed, the session history is not empty, etc.
In case of any issues during the restore procedure or additional questions, please contact our support and we will assist.