Export and Import

Use export when you want to capture the current CloudPeek images — and optionally the data volumes — so you can move CloudPeek to another host or keep a backup. import stands that export back up on the destination host.

Exporting an existing instance

From inside the cloudpeek/ directory of your existing install:

cd cloudpeek
./cpk export

This produces an output_folder/ in your current directory containing:

• A complete copy of your install directory — the cpk binary, the compose file, the .secrets/ directory, and the other supporting files.
• cloudpeek-images.tar.gz — the current Docker images.

Including your data volumes

If you also want to back up your data (database contents, uploaded files, and so on) pass the --save-data flag:

./cpk export --save-data

Volume archives are written to output_folder/volumes/.

Importing a previous export

On the destination host, copy the entire output_folder/ produced by export over (for example via scp or a USB drive), rename it to cloudpeek/, and enter it:

mv output_folder cloudpeek
cd cloudpeek
./cpk import

The rename is only for tidiness — import cares that you run it from inside the directory, not what the directory is called.

import will:

1. Check that the compose file, cloudpeek-images.tar.gz and .secrets/compose.env are all present, and load your exported settings. A missing .secrets/compose.env stops the import with Missing required file: .secrets/compose.env.
2. Load the CloudPeek Docker images from the archive.
3. Make sure the third-party images are on the host, downloading only any that are missing. An air-gapped export needs no network here.
4. Offer to restore the data volumes, if the export contains any. Answer y to restore; any other answer starts with a fresh database. This prompt only appears if you exported with --save-data.
5. Start the full stack.

When it finishes you have a running copy of the exported CloudPeek instance on the new host.

Related

• Uninstalling CloudPeek: export first — uninstalling deletes your data.
• Updating CloudPeek: upgrading in place instead of moving hosts.
• Installing CloudPeek: a fresh install on the destination host.