# The Console Component The Composable Agentic Platform console component should be backed up in the same manner as any other application server installation. The application server path itself, any database used by it, and the home folder all need to be backed up at the same time. During a restore, the HOME folder should be restored in synchronization with the application server and database restore. ## Minimum backup set If you are performing a selective backup rather than a whole-host image, the minimum set of paths to include is: * The Console installation directory (the application server binaries, webapps, and configuration files you laid down at install time). * The entire `HOME/` directory. This contains all customer-owned state: the Coop and config Derby databases, rule repositories, rulesets, deployed configurations, content files, test data, trace data, Case Managers, custom protocols, and per-Agent runtime directories. * Any external database used in place of the shipped Derby databases (if you have replaced Derby with MySQL, PostgreSQL, Oracle, or similar). All three must be backed up together and restored together. A Console install directory with a mismatched `HOME/` or a mismatched external database will not start correctly. ## Critical for V12 and later: `HOME/Data/installation.key` Starting with V12, the Console Coop database contains credential fields (user passwords for SMTP, JDBC, the update server, credential vaults, and more) encrypted under an installation-specific key stored in a single file: ``` HOME/Data/installation.key ``` This file is 32 bytes in size and has owner-only file permissions. It is generated automatically on first boot after a V12 upgrade or on a fresh V12 install. **A backup of the Coop database without `installation.key` is unrecoverable.** The stored credentials cannot be decrypted without the matching installation key that was in place when they were encrypted. Replacing the key with a freshly generated one does not help — the encryption is tied to the specific 32 bytes. Ensure your backup procedure: * Includes `HOME/Data/installation.key` in every backup that covers `HOME/Data/`. Most whole-`HOME/` recursive backups already do — verify on your next scheduled backup. * Stores the installation key with the same security controls as the Coop database backup. Anyone with both the Coop backup and the installation key can decrypt the stored credentials offline. * Never stores the installation key in a different security domain from the database it protects (for example, do not send the Coop backup to cold storage while keeping the key only on the live host). ## Restore considerations * Restore `HOME/` and the Console install directory as a matched pair from the same backup snapshot. Mixing a `HOME/` from one backup with binaries from another can produce decryption failures or configuration drift. * `HOME/Data/installation.key` must be restored alongside `HOME/Data/Coop/`. Restoring Coop without the matching key will leave all stored credentials unreadable. * If restoring to a different host, the `installation.key` file's ownership and permissions must be re-applied so the restored Console service user can read it (`0600`, owned by the service user on POSIX; equivalent ACLs on Windows). --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.tomorrowx.com/cap/product-reference/backup-and-restore/the-console-component.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.