Page Comparison

FLEXDEPLOY_HOME

Yes

This is the directory location where FlexDeploy will be installed or is already installed, the default is /u01/flexdeploy.

FLEXDEPLOY_JAVA_HOME

Yes

This is the path to the appropriate Java JDK 8, it would for FlexDeploy. It should be the path up to bin (, but not including bin).

Note that for FlexDeploy < 9.0 this is JDK 8, and for FlexDeploy 9.0+, this is Java 11 or 17.

WORKING_DIRECTORY

No

Defaults to ${FLEXDEPLOY_HOME}/application

This will be the directory location that FlexDeploy uses for temporary files to be transferred between the server and its endpoints.  The default location is under FLEXDEPLOY_HOME and is named application.

ARTIFACT_REPOSITORY_DIRECTORY

No

Defaults to ${FLEXDEPLOY_HOME}/artifacts

this will be the directory location that FlexDeploy uses to store all build artifacts and retrieve deployment artifacts. The default location is under FLEXDEPLOY_HOME and is named artifacts.

BACKUP_DATABASE_DIRECTORY

No

The directory where the database will be backed up to.

This value is optional.

If Oracle, this directory must already exist within the DBA_DIRECTORIES table and the DIRECTORY_PATH for the entry must exist on the file system on the Database Server.

If Oracle, and BACKUP_DATABASE_DIRECTORY is blank, the DEFAULT data_pump directory is used if needed.

If PostgreSQL, and BACKUP_DATABASE_DIRECTORY is provided, the database will be backed up to this local folder using the psql command, which must be available on this local host.

If PostgreSQL, and BACKUP_DATABASE_DIRECTORY is blank, the database schemas will be backed up by cloning to another schema in the same database.

INFLUXDB_PORT

No

InfluxDB port

Defaults to 8086 if not specified.

If running multiple influx servers on a single box, they must use different ports.

FLEXDEPLOY_DB_PASSWORD

No

The password for fd_admin database user.

The password will be prompted if not specified.

SYSTEM_DB_USER

Yes

Usually set to system for Oracle and postgres for PostgreSQL.

This user will create and update the schema definitions

SYSTEM_DB_PASSWORD

No

The superuser / system password for the user SYSTEM_DB_USER

This password is required to create and update schema definitions

The password will be prompted if not specified.

FLEXDEPLOY_PORT

No

Defaults to 8000 for standard installs, 8004 for Docker installs.

If you are deploying SSL this port setting will likely not be helpful other than it sets the port that is shown in the message once FlexDeploy is running.

MAINTAIN_EXISTING_CONTEXT_FILE

No

Defaults to 1

If 0, then the installation process will use the newly downloaded context.xml file and adjust the properties accordingly.

If 1, then the installation process will save the existing context.xml and replace it after the upgrade so there are no changes to it.

Set to 1 if you have changes to the context.xml file that you wish to maintain such as using a password manager for your database password in context.xml.

MAINTAIN_EXISTING_SERVER_FILE

No

Defaults to 1

If 0, then the installation process will use the newly downloaded server.xml file and adjust the properties accordingly.

If 1, then the installation process will save the existing server.xml and replace it after the upgrade so there are no changes to it.

If running SSL and upgrading, 1 is likely the easiest option.

From very old versions, choosing 0 and then manually modifying the file may be the easiest option.

DATABASE_URL

Yes

Adjust the appropriate connection string for the FlexDeploy database, Oracle or Postgres.

Verify that your DATABASE_URL line isn’t commented out (# at the beginning of the line) and that all other DATABASE_URL lines are commented out.

Several examples are listed in the config file.

CONTAINER_NAME

No

Only used for Docker

Defaults to flexdeploy

If installing FlexDeploy through Docker you can set the name of the container that will be created by editing the variable below. Defaults to 'flexdeploy'