Backup / Restore

This section covers the InterWorx Control Panel backup system and how to restore backups of your SiteWorx accounts, both from the NodeWorx interface and the SiteWorx interface. From within NodeWorx you can restore full backups of multiple SiteWorx accounts. From within SiteWorx, you can only create a backup of that particular account, but you will be able to create partial and full backups.

How-To:

• Backup
  • Create a SiteWorx Backup in NodeWorx
  • Create a SiteWorx Backup via CLI
  • Create an .ini For Remote Transfers
• Restore
  • Restore From NodeWorx
  • Restore From CLI
• Delete a SiteWorx Account Backup from NodeWorx
• Frequently Asked Questions

If you prefer to use the web interface, follow the steps below:

1. Click the SiteWorx menu item if it is not already open.
2. Click the Backup / Restore menu item.
3. You will see a list of all the SiteWorx accounts on the server, with a checkbox next to each. If you are logged in with a NodeWorx Reseller account, you will only see the SiteWorx accounts that belong to you.
4. Mark the checkboxes for the SiteWorx accounts you wish to backup. You may also click the [ Check All ] link at the bottom of the list to quickly check all SiteWorx accounts.
5. Mark the labeled E-mail status to checkbox and enter your email address if you want an email sent to you when the backup process finishes. When the backup completes, you will receive an email that indicates if the backup completed successfully or not, as well as where to find the backup file.
6. Choose the Backup option in the dropdown labeled with selected:
7. You have now successfully initiated a backup from NodeWorx.

The command line backup interface is less user-friendly, but you have a lot more options at your disposal. Using the command line interface is most useful when you want to automate (e.g., via CRON) the creation of SiteWorx account backups.

1. SSH into the server
2. su to the iworx system user. You may need to switch to the root user first (if you're not already logged in as the root user) and then switch to the iworx user.

The command you will be running is, as the iworx user:

[iworx@test-box ~]$ /home/interworx/bin/backup.pex

backup.pex has several command line parameters:

In its simplest form, you can create a full backup of a single SiteWorx account and have it stored in the default location (/home/uniqname/backups):

[iworx@test-box ~]$ /home/interworx/bin/backup.pex --domains domain1.com

To create full backups of a SiteWorx account and send a status email to joe@user.com:

[iworx@test-box ~]$ /home/interworx/bin/backup.pex --domains domain1.com --email joe@user.com

To create a partial backup of web and database data of a single SiteWorx account and have it stored in the default location (/home/uniqname/backups):

[iworx@test-box ~]$ /home/interworx/bin/backup.pex \
                    --domains domain1.com \
                    --web --databases

To create full backups of multiple SiteWorx accounts with each backup saved in their respective backup directories:

[iworx@test-box ~]$ /home/interworx/bin/backup.pex \
                    --domains domain1.com domain2.com

To create full backups of multiple SiteWorx accounts with each backup saved in /tmp:

[iworx@test-box ~]$ /home/interworx/bin/backup.pex \
                    --domains domain1.com domain2.com  \
                    --file-path /tmp

To create a full backup of multiple SiteWorx accounts and have them transferred to a server specified in /root/transfer.ini via FTP:

[iworx@test-box ~]$ /home/interworx/bin/backup.pex \
                    --domains domain1.com \
                    --ftp \
                    --transfer-ini /root/transfer.ini

The following is the proper format for the transfer.ini files used by the InterWorx backup system.

[scp]
username="user"
password="your password"
hostname="hostname.domaine.tld"
remotepath="~/yourbackupdir/"
port="22"

[ftp]
username="user"
password="your password"
hostname="hostname.domaine.tld"
remotepath="~/yourbackupdir/"
port="21"

Note that the text [scp] or [ftp] must be the first line in the file. The [scp] section is used for SCP/SSH remote transfers, and the [ftp] section is used for FTP remote transfers.

If you prefer to use the web interface, follow the steps below.

1. Click the SiteWorx menu item if it is not already open.
2. Click the Backup / Restore menu item.
3. You will see a list of all the SiteWorx accounts on the server, with a checkbox next to each. If you are logged in with a NodeWorx Reseller account, you will only see the SiteWorx accounts that belong to you.
   1. If the SiteWorx account currently has no backups, you will see No Backups in the Status column.
   2. If the SiteWorx account does have backups you will see a [ Manage ] link in the Status column. Click the [ Manage ] link corresponding to the SiteWorx account you would like to restore.
4. You will see a list of all the backup files for that SiteWorx account with [ Restore ] link corresponding the the backup file you would like to restore.
5. Because a restore will overwrite existing data in the SiteWorx account, you will be asked to confirm. Click the Restore button to restore the account.

Restoring from the CLI is the same process as importing a SiteWorx account backup from another InterWorx server via CLI except you would want to --force the import to overwrite the existing SiteWorx instance. Please refer to the import documentation for further details.

1. Click the SiteWorx menu item if it is not already open.
2. Click the Backup / Restore menu item.
3. You will see a list of all the SiteWorx accounts on the server, with a checkbox next to each. If you are logged in with a NodeWorx Reseller account, you will only see the SiteWorx accounts that belong to you.
   1. If the SiteWorx account currently has no backups, you will see No Backups in the Status column.
   2. If the SiteWorx account does have backups you will see a [ Manage ] link in the Status column. Click the [ Manage ] link corresponding to the SiteWorx account you would like to restore.
4. You will see a list of all the backup files for that SiteWorx account with a checkbox next to each backup file. Mark the checkboxes for the files you wish to delete. You may also click the [ Check All ] link at the bottom of the list to quickly check all the backup files.
5. In the dropdown labeled with selected:, choose the Delete… option.
6. You will be asked to confirm the deletion of the backup files. Click the Delete button to finish.