Skip to main content
Version: Next

Environment Variables and Properties

Obfusware uses both environment variables and java properties as configuration values. Each environment variable has a corresponding java property. If a java property is set, it will override any environment variable value.

Values that have property name in angle brackets (e.g. file/path/<property>/filename.ext), indicate that the specified property value should use in place of the property tag <property>.

Operating System Environment Variables and Java Properties​

Obfusware uses some Operating System (OS) environment variables and corresponding Java properties for configuration.

  • UserName - Used to determine the name of some user specific Obfusware directories.
    • Environment Variable: USER
    • Java property: user.name
    • default value: obfusware
  • UserHome - Used to determine the name of some user specific Obfusware directories.
    • Environment Variable: HOME
    • Java property: user.home
    • default value: /home/<UserName>
  • WorkingDirectory - Used to determine the absolute path of relative file paths, especially by Obfusware scripts.
    • Environment Variable: PWD
    • Java property: user.home
    • default value: -NONE-

Obfusware Environment Variables and Java Properties​

Environment variables and java properties used defined by Obfusware and used as configuration properties.

  • ObfuswareEnvironment - Obfusware defines 4 different execution environments: Development, Test, Staging, and Production. The main use of the environment property is to select the configuration to be used when executing. See Environment Specific Configuration Files for details.

    • Environment Variable: OBFUSWARE_ENVIRONMENT
    • Java property: obfusware.environment
    • default value: Production

  • ObfuswarePlatform - Obfusware supports different execution platforms. These include: Minimum, Java, ApacheSpark, and AWSGlue. Obfusware uses the currently selected platform to determine values such as the default file path for the configuration file. For instance, on the AWSGlue platform the default configuration file path is:
            s3://obfusware-<aws_account_num>-<aws_region>/config/obfusware-config.json.
    On the ApacheSpark platform the default configuration file path is:
            /usr/local/obfusware/config/obfusware-config.json.

    • Environment Variable: OBFUSWARE_PLATFORM
    • Java property: obfusware.platform
    • default value: Minimum

  • ObfuswareVersion - The current version of Obfusware. In general, this property should not be set. Use the default value, unless advised by Obfusware support.

    • Environment Variable: OBFUSWARE_VERSION
    • Java property: obfusware.version
    • default value: <current_build_version>

  • ObfuswareInstall - This is the directory where Obfusware is installed. This is used as the base to determine the location of other directories, such as the configuration directory.

    • Environment Variable: OBFUSWARE_INSTALL
    • Java property: obfusware.install
    • default value: s3://obfusware-<aws_account_num>-<aws_region>/

  • ObfuswareHome - This is the directory where Obfusware where all Obfusware files are located by default. The ObfuswareHome directory is formed by appending the version to the ObfuswareInstall property. This allow multiple versions of Obfusware to be installed and executed on the same system.

    • Environment Variable: OBFUSWARE_HOME
    • Java property: obfusware.home
    • default value: s3://obfusware-<aws_account_num>-<aws_region>/<version>/

  • ObfuswareUserHome - When executing Obfusware will use the ObfuswareUserHome to determine configuration if it is set. This allows setting up different execution configurations based on the user account executing Obfusware.

    • Environment Variable: OBFUSWARE_USER_HOME
    • Java property: obfusware.user.home
    • default value: s3://obfusware-<aws_account_num>-<aws_region>/users/<user_name>/<version>/

  • ObfuswareConfigDir - The name of the directory that contains the configuration file and license file. To determine full path the ObfuswareConfigDir is appended to the ObfuswareHome property.

    • Environment Variable: OBFUSWARE_CONFIG_DIR
    • Java property: obfusware.config.dir
    • default value: config

  • ObfuswareConfigFilename - The filename of the initialization configuration file. The file in located in the ObfuswareConfigDir by default.

    • Environment Variable: OBFUSWARE_CONFIG_FILENAME
    • Java property: obfusware.config.filename
    • default value: obfusware-config.json

  • ObfuswareConfigFile - The absolute file path of the initialization configuration file. If defined the this file path is used to locate and load the configuration file. If not defined then then the ObfuswareConfigDir and ObfuswareConfigFilename are used to locate the configuration file.

    • Environment Variable: OBFUSWARE_CONFIG_FILE
    • Java property: obfusware.config.file
    • default value: s3://obfusware-<aws_account_num>-<aws_region>/config/obfusware-config.json

  • ObfuswareLicenseFilename - The filename of the Obfusware license file. The file in located in the ObfuswareConfigDir by default.

    • Environment Variable: OBFUSWARE_LICENSE_FILENAME
    • Java property: obfusware.license.filename
    • default value: obfusware-license.lic

  • ObfuswareLicenseFile - The absolute file path of the Obfusware license file. If defined the this file path is used to locate and load the license file. If not defined then then the ObfuswareConfigDir and ObfuswareLicenseFilename are used to locate the license file.

    • Environment Variable: OBFUSWARE_LICENSE_FILE
    • Java property: obfusware.license
    • default value: s3://obfusware-<aws_account_num>-<aws_region>/config/obfusware-license.lic