configure script allows you to manage and deploy custom configurations to Appian installations in a repeatable manner. It also aids with the initial setup of the configurations required for running Appian on the JBoss application server. JBoss is the only application server handled by the
configure script at this time, however the deployment of configurations to Appian will work regardless of which application server you use. See System Requirements for the supported version of JBoss.
Results of the script are logged to configure.log in the same directory in which the script resides.
Use of a version control system in conjunction with the script is highly recommended. The script creates a repository directory in which all configuration files are stored before being deployed. This directory should be version controlled using your preferred version control mechanism, such as Git.
The typical life cycle of using the
configure script to aid configuration management with Appian is as follows:
configurescript to deploy the configurations to either JBoss, Appian, or both.
Note: The configure script does not change configurations. It deploys the configurations that are stored in its repository. You must change configuration files like custom.properties, password.properties, and appian-topology.xml. Change these files in the configure script repository, version control the changes, and then use the configure script to deploy the changes.
To run the script
The script provides a menu driven interface for executing the various configuration and deployment tasks. The script can also be run in a non-interactive manner by passing parameters on the command line when executing the script—see the Silent Mode section for details.
The first step when running the
configure script on a new machine is creating a repository. The configuration repository is where your custom configurations will be stored.
After you create a repository, the repository location is displayed in the menu's banner and additional menu options become available. Also, the menu option to create a repository becomes an option to change the repository location, which creates a new repository at the given new location.
Backing up the Appian directories is recommended before deploying any custom configurations. The following directories contain configuration files and are backed up when using this menu option:
Run this script option after installing Appian but before deploying any custom configurations in order to create a backup copy which can be restored. To undo all custom configurations, restore from this backup by deleting the directories from Appian and copying these backup directories to the
2 - Create initial backup of Appian installation
configure script does not back up Appian data. Use the scripts described in the Data Maintenance page to manage data backups.
See also: Data Maintenance
This option is only available once you have created a repository.
An environment is an Appian instance that has different configurations than other instances. For instance, you may have one set of configurations for your development environment and a different set of configurations for your production environment.
Creating a new environment creates an initial copy of configuration files from templates that are specific to that environment. When deploying configurations, the environments you create will be available as selectable options and the corresponding files will be copied to the target instance of Appian.
3 - Register an environment
The following names are reserved and cannot be used as an environment name:
configure script does not modify values in the configuration files in the repository.
The one exception to this rule is that during deployment the script will set the value of
APPIAN_HOME_EAR in JBoss'
standalone.conf based on the directory from which the
configure script is run. To override this behavior you can replace the string of
@appian-ear.path@ with the desired path.
After registering an environment, set the desired configuration values for that environment by editing the configuration files suffixed with the environment name. Additionally, you can provide new files in the configuration repository that will be copied to the target when deploying. For instance,
k3.lic.envfile placed in
k4.lic.envfile placed in
<REPO>/data-server/engine/bin/q/l64/will be copied to the corresponding directories in
envenvironment is deployed.
com/mysql/jdbc/mainsubdirectory of the
<REPO>/bin/jboss/jboss-eap-<ver>/modulesdirectory and adding the MySQL driver jar and
module.xmlto it will cause that directory and contents to be copied to the corresponding directory in
For more details on setting configuration values see:
This option is only available once you have created a repository.
configure script can conduct a minimal review of the configuration files to verify that
custom.properties is present and that the essential properties are defined there.
4 - Validate configurations
Validation of a specific environment is also performed automatically when you deploy configurations for the selected environment.
This option is only available once you have registered an environment.
The configuration script deploys configurations by copying the configuration files from the repository directory to the target Appian and JBoss directories.
Before executing this option you must edit the appropriate configuration files for the environment that you wish to deploy.
5 - Deploy configurations
If you have not run a backup before deploying configurations, the script will prompt you to run an optional backup before deploying configurations.
The script will prompt you to enter the location of the JBoss directory if you haven't already and will remember that directory the next time you run the script. You can make the configure script forget the JBoss directory location by editing the
.configure file in
<APPIAN_HOME>/_admin/_scripts/configure and removing the line that starts with
If multiple versions of JBoss are supported by the version of Appian you are running, you will be prompted to select which version to deploy.
The tools menu contains utilities to aid in the configuration and deployment of Appian.
Encoding passwords for use in JBoss data source configurations
6 - Tools
1 - Encode password for JBoss Security Domain
See also: Configuring JBoss
The above activities are available as command line options allowing you to build scripts that bypass the menu-driven interactive interface. The silent mode is accessed by passing
-silent as a parameter to the script. The task name for the desired activity must be passed as
task=value, plus any parameters necessary for that task. Additional parameters and their corresponding values are passed in the
parameter=value format. For example, to run the
1 configure.sh -silent task=deployAppianConfigurations environmentName=dev
|Back up Appian||
||A repository must have been created, either through silent mode or using the menu-driven interface.|
|Deploy Configurations to Appian||
|Deploy Configurations to JBoss||
|Encode JBoss Security Domain Password||