Note

You are viewing the documentation for an older release of Interworx (6.x). To see documentation for the current generally available release of Interworx, click here: 7.13.

How to Create s3 Backups with InterWorx

Siteworx backup .tar.gz files can now be transferred to AWS S3 or S3 compatible object store upon creation.

An AWS S3 profile and target can be configured using ~iworx/bin/s3.pex with the following examples:

# cat /root/tmp_creds
aws_access_key_id=XXX
aws_secret_access_key=YYYYYYY

# Create AWS profile
$ ~iworx/bin/s3.pex --configure --credential-file /root/tmp_creds --profile profile_name --region us-east-2

# Or, Create AWS compatible profile
$ ~iworx/bin/s3.pex --configure --credential-file /root/tmp_creds --profile profile_name --endpoint https://objects.domain.tld

# Create a bucket (if needed)
$ ~iworx/bin/s3.pex --create-bucket --profile profile_name --bucket bucket_name

# Add a target
$ ~iworx/bin/s3.pex --add-target --profile profile_name --target target_name --bucket bucket_name --path backup/path

Siteworx backups can be created and transferred to the specified s3 target using the --to-s3-target flag.

Example:

~iworx/bin/backup.pex --domain [domain] --to-s3-target [target_name]

SiteWorx backups can be imported as a different master domain or unix user using the --override-master-domain and --override-unix-user flags for ~iworx/bin/import.pex.

Note

Only applies to backups that do not contain secondary domains, and must be imported via the CLI.

Example:

~iworx/bin/import.pex --archive [file] --control-panel siteworx --ipv4 [ip] --override-master-domain [new-domain] --override-unix-user [new-unix-user]

Note

It is possible to create a backup of just the master domain, or of just a secondary domain as if it were a master domain with the –master-only or –as-master flags, respectively for ~iworx/bin/backup.pex.

Examples:

Create a backup of just the master domain, with no secondary domains:

~iworx/bin/backup.pex --domain [domain] --master-only

Create a backup of a secondary domain as if it were a master domain:

~iworx/bin/backup.pex --domain [secondary domain] --as-master