Linux - Activate IAA via configuration file

You have the option of activating or retrofitting the Intrexx Administration API via the command line using a configuration file.

To do this, you need the configuration file "configuration.yml" described earlier in the section Linux Linux - Installing IAA using a configuration file file.

Additionally, you need another configuration file "admin_api.yaml", in which the port to the IAA, the IAA username and the IAA user’s password have to be stored. If the IAA is installed retroactively, the files "configuration.yml" and "admin_api.yaml" are called up as parameters and the saved information is processed.

configuration.yml

After Intrexx has been installed, you will find a "configuration.yml" file under the following path:

<intrexx-installation-directory>/installer/cfg/configuration.yml

admin_api.yaml

The file "admin_api.yaml" looks like this:

username: "example-user"
password: "example-password"
port: 4242

You can find a sample file for an "admin_api.yaml" in the Intrexx setup files (before Intrexx is installed) under the following path:

<IX_Intrexx-Version>admin-api/cfg/admin_api_example.yaml

Activate IAA via configuration file

To activate the IAA via a configuration file, run the "setup.sh" file, which can be found under the following path:

<intrexx-installation-directory>/installer/setup/content

The setup.sh is called with parameters that indicate the configuration files "configuration.yml" and "admin_api.yaml".

The subsequent installation steps correspond to those of the Maintenance mode.

The README file, which can be found in the setup under admin-api/README.txt, also describes this procedure.

Manually saving the portal password

After you have activated the Intrexx Administration API, save the password for your portal in the admin-api.yaml file. This can be found under the following path: \<intrexx-installation-directory>\admin-api\cfg\

For more detailed information, see the section Portal password.