Exporting the project configuration
You can use the export_project_repository_config CLI to export the configuration settings of an existing project. This includes database definitions, scheduling jobs, and notifications. This is helpful, for example, when you need to migrate configuration settings from a test environment to the production environment.
For information about migrating projects, see Moving projects from the test environment to the production environment.
Command syntax:
ComposeCli.exe export_project_repository_config --project project_name --outfile output_file [--is_without_credentials] [--password password] [--master_user_password master_user_password]
Parameters
| Parameter | Description |
|---|---|
| --project | The name of the project. |
| --outfile | The path to and name of the output file. This file is in JSON format (e.g. C:\file.json). |
| --is_without_credentials | Use this parameter to specify that you want to export the project settings without the encrypted fields. When importing to a new project, you will need to manually enter the project passwords (in the Compose database connection settings) after the import completes. In addition to eliminating the need to specify a password when exporting or importing the project, the is_without_credentials parameter also allows the project to be used in every Compose installation, regardless of its master user password. It is also useful in the event that you would like to keep the existing passwords in the target environment (e.g. when exporting from a testing environment to an existing project in the production environment). |
| --password | The password for encrypting the credentials in the exported project. When used, this parameter must be used together with the master_user_password parameter described below. Use the password > parameter if you want to encrypt the credentials in the exported project, but do not want the source master password to be used in a different environment. The specified password must be at least 32 characters in length and can either be user-devised or generated using the genpassword utility described in Changing the master user password. |
| --master_user_password |
The master user password defined for the source machine. When used, this parameter must be used together with the password parameter. Use the master_user_password > parameter if you want to encrypt the credentials in the exported project, but do not want the source master password to be used in a different environment. In such a case, when you import the project to an environment that has a different master password, you will only need to specify the password qualifier. For instructions on changing the master user password, see Changing the master user password. See also: Moving projects from the test environment to the production environment and Import/export scenarios - When is a password required? |
Example
Export project configuration without a password
ComposeCli.exe export_project_repository_config --project MyProject --outfile file.json --is_without_credentials
Export project configuration with a password
ComposeCli.exe export_project_repository_config --project MyProject --outfile file.json --password MyPassword --master_user_password MyMasterUserPassword