. . .

Environment variables

The required variables are printed in bold.

  • All variables starting with "yambas_" should only be used for the Yambas container.

  • All variables starting with "dashboard_" should only be used for the dashboard container.

  • All variables starting with "common_" should be used in the Yambas and Dashboard container.

  • All other variables are marked accordingly. (Dashboard, Yambas, Mongo)

Variable

Description

USE_ALPHA_ENVIRONMENT_VARIABLES (D,Y)

This causes the following variables to take effect. This means that to use environment variables, the variable must be "true".

common_hosts_admin

the internal address yambas and the dashboard uses to reach itself

common_hosts_live

the public address for the live system, used e.g. in sdks or app-configuration

common_hosts_staging

the public address for the staging system, used e.g. in sdks or app-configuration

common_hosts_test

the public address for the test system, used e.g. in sdks or app-configuration

common_isEnterpriseInstallation

indicates whether ApiOmat is started as enterprise version; defaults to false

common_isWhitelabelInstallation

indicates whether ApiOmat is started as whitelabel version; defaults to false

common_defaultOrganizationEmail

the default organization's email address; defaults to org@apiomat.com

common_defaultOrganizationPassword

the default organization's password; defaults to secret

common_sendCustomerVerificationMailImmediately

sends the verification emails immediately; defaults to false

common_superadminEmail

If you change the SuperAdmin credentials in the Dashboard, the credentials below must match them

common_superadminPassword

SuperAdmin account's password; defaults to secret

common_useSsl

rewrite urls with https, deprecated; defaults to false

common_emails_noreply

the noreply-email address

common_emails_support

the support-email address (e.g. used as sender for "forgot password"-requests)

common_emails_admin

the email's sender address ("from") used to send admin emails

common_emails_footer

the message footer for emails if not sent over mandrill

common_emails_debug

debug option to print verbose information during email sending

common_emails_host

Hostname of the SMTP server

common_emails_user

Username if authentication on SMTP server is necessary

common_emails_password

Password if authentication on SMTP server is necessary

common_emails_port

Port of the SMTP server

common_emails_useAuth

TRUE if authentication is needed in SMTP server

common_emails_useSsl

TRUE if SSL connection should be used

common_emails_useStarttls

TRUE if STARTTLS should be used

common_analytics_enabled

Settings for the ApiOmat-Analytics module

common_analytics_internal

The internal address from which the analytics instance is available

common_analytics_public

The external address where the instance is available, used for sdks

audit_enabled

enables the audit-feature; it is disabled by default

audit_contentEnabled

enables writing the create/update data to the log

yambas_license_key

the ApiOmat license key

yambas_mandrillApiKey

Mandrill API key - only needed if you want to send customized emails via Mandrill;

yambas_yambasWebappDir

the path to WebAppDir of yambas, used to set the read-FilePermission

yambas_noSystemCache

caches the cluster-urls internally in a map (during lifetime of yambas)

yambas_enableMultipleCSVImport

enables csv-import for the same resource at a time: defaults to false

yambas_defaultModules

Comma separated list of modules to attach to all apps by default (like the "Basics" module)

yambas_defaultModulesPerSystem_live

Comma separated list of modules to attach to all apps by default for the live system

yambas_defaultModulesPerSystem_staging

Comma separated list of modules to attach to all apps by default for the staging system

yambas_defaultModulesPerSystem_test

Comma separated list of modules to attach to all apps by default for the test system

yambas_accessControlAllowOriginList

You can set a list of URIs that will be the only allowed origins when CORS requests get received. E.g.: "http://localhost, http://some.host, https://other.secure.domain, file://"

"*" allows all origins (but must be valid URIs). "none" or an empty value allows NO CORS requests. Default is "*".

yambas_logTaskPeriodInSeconds

the time between one LogSaveTimer (for async save of logs in native modules) start and another in seconds; defaults to 30 seconds

yambas_cronThreads

The number of threads being used for executing CRON hooks. Default is 10. Note: For a CRON hook to be executed in a new thread at all, the module must be configured with "runCronInNewThread = true" in its "@Module" annotation. Otherwise the hooks get executed by one single CRON timer thread, one after another.

yambas_useOldClassloader

use of old classloader behaviour

yambas_cacheResourcesInClassloader

cache already requested resource files of the module internally, defaults to true, size can be adjusted with the property yambas.limits.cacheResourcesInClassloader

yambas_mongodb_hosts_default

mongodb hosts comma separated for multiple, may have a port after each value,
e.g. "localhost:27017", otherwise the default port 27017 will be used

yambas_mongodb_hosts_live

if this value is not present, the values from default will be used

yambas_mongodb_hosts_staging

if this value is not present, the values from default will be used

yambas_mongodb_hosts_test

if this value is not present, the values from default will be used

yambas_mongodb_userPassword_default

default password for each stage, if no value present, the default will be used
if the password is an empty string, no auth will be used!

yambas_mongodb_userPassword_live

if this value is not present, the values from default will be used

yambas_mongodb_userPassword_staging

if this value is not present, the values from default will be used

yambas_mongodb_userPassword_test

if this value is not present, the values from default will be used

yambas_mongodb_userName_default

the username to use for a connection to the database; defaults to "apiomat"

yambas_mongodb_userName_live

the username to use for a connection to the database; defaults to "apiomat"

yambas_mongodb_userName_staging

the username to use for a connection to the database; defaults to "apiomat"

yambas_mongodb_userName_test

the username to use for a connection to the database; defaults to "apiomat"

yambas_mongodb_authDB

the auth database to use for the authentication, defaults to "admin"

yambas_mongodb_readPreference

may be one of: "nearest", "primary", "primaryPreferred", "secondary", "secondaryPreferred"

yambas_mongodb_writeConcern

the write concern may be one of: "ACKNOWLEDGED", "FSYNC_SAFE", "FSYNCED", "JOURNAL_SAFE", "JOURNALED"

yambas_mongodb_connections

number of connections one mongodb-client will establish,

yambas_mongodb_binPath

Path to binary folder of mongodb, used for RestoreModule:

yambas_mongodb_dumpPath

Path where to dump the mongodb database of an app, used for RestoreModule;

yambas_mongodb_testConnectionTimeout

On startup, there is an additional checkup whether the database is available. This check has a 5 second timeout set by default. If there is no response from the database after that time, Yambas responds to any request with the related errormessage. In most cases these 5 seconds should be enough for the connection timeout, but you can adjust it here, if the connection needs more time. Note that the timeout is only set for the test connection. The regular clients use the default timeouts.

yambas_ftp_keystore_path

Path and password to keystore used by SFTP server

yambas_ftp_keystore_password

password of keystore

yambas_ftp_port

Port of FTP server; defaults to 2021

yambas_ftp_passivePorts

the passive ports to use, may be a single port, e.g. "2300", multiple comma-separated "2300,2301", port range e.g. "2300-2305" (without end-port means all ports over ...), or a combination, e.g. "2300,2301,2400-"

defaults to 2300

yambas_limits_unconfirmedMaxdays

number of days a customer can be unconfirmed, until he will be locked

yambas_limits_maxCronTime

Maxmum number of milliseconds a cron task execution is allowed to take

yambas_limits_maxResults

The maximum number of items to be included in the result of getAll requests;

yambas_limits_maxCompileTimeInMinutes

The maximum number of minutes which is allowed for a module to compile

yambas_limits_maxStringSizeOnExport

The maximum size of strings to be exported using CSV or XML export;

yambas_limits_maxDataJsonKB

The maximum KB size of static data (e.g. images) which should be returned directly in JSON data

yambas_limits_maxDataUploadMB

The maximum data size for uploads in MB (with 1 MB = 1,000,000 Bytes)

yambas_limits_maxHookCallDepth

The maximum depth in hook method calls

yambas_limits_maxResourceCacheSizeKB

maximum size of a file in kb to be put in the resource cache, defaults to 10 (only takes effect if yambas.cacheResourcesInClassloader is enabled)

yambas_planTrialReminderDays

give the days to send a reminder mail x-days before the trial expires

yambas_planDefault

name of the default plan

yambas_oAuth2TokenValiditySeconds_standard_access

value in seconds

yambas_oAuth2TokenValiditySeconds_standard_refresh

value in seconds

yambas_oAuth2TokenValiditySeconds_manuallySet_access

value in seconds

yambas_oAuth2TokenValiditySeconds_manuallySet_refresh

value in seconds

yambas_configEncryptionKey

The configEncryptionKey used for encryption of e.g. module configuration passwords. It gets overwritten by a randomly generated value during installation. Should be 16, 24 or 32 characters long. Other lengths get trimmed to the next lower valid length. After installation, when this value is the randomly generated one, it must not be changed when updating yambas!

yambas_git_conflictmode

behaviour how to react on a conflict in git (changes in dashboard and repository at the same time),
may be either "branch" (create a branch with dashboard changes) or "force" (force-push changes to current branch)
defaults to "branch"

yambas_git_directory

path where to temporary check out the git-repositories, defaults to System.getProperty("java.io.tmpdir")

yambas_strictChecks

strict authorization checks in nativemodules, false will do less checks and is only allow backward

dashboard_cacheEnabled

enable cache of dashboard

dashboard_disableSSLChecks

disable ssl checks of dashboard

dashboard_embeddedObjectsSupport

Hide embedded objects switch if set to false

dashboard_helpUrl

help URL for Dashboard. Default: /docs, Dashboard comes without internal docs. Enter a Web address for the external documents.

dashboard_deployCheckInterval

check interval of deploy

dashboard_curlRequestTimeout

timeout of curl requests

monitoring_eurekaHost

URL for the eureka service, which is used to connect to monitoring services

monitoring_user

user of eureka service

monitoring_password

password of eureka service

tools_apiomatStudioMobile_appLocation

configuration for the ApiOmat Mobile Studio:

address where the files for the apiomat studio mobile are deposited

tools_apiomatStudioMobile_templateLocation

address where the files for the example projects are deposited

DEBUG (D,Y)

Information about variable mapping is displayed.

HAZELCAST_NEARCACHE_ENABLE (Y, >=3.1.3)

The nearcache of hazelcast (used for internal caching of Customers and Backends) was enabled in versions prior to 3.1.3 by default, but may lead to inconsistencies when reading the data. Therefore we disabled it by default in versions after 3.1.3 and 3.2.0. To enable it again, set this to true

YAMBAS_EXTERNAL (D)

Address to yambas. The service name can be used here (like "yambas")

YAMBAS_EXTERNAL_PORT (D)

internal AJP port from Yambas Service. 10009 is the best choice here

ENV_MODE (D,Y)

DEVELOPMENT or PRODUCTION

ALIAS (D)

Alias of virtual host for Dashboard: Usually the Dashboard is reached under "/".

PROXY_TIMEOUT

AJP Proxy Timeout: Timeout between Dashboard and Yambas can be increased here.

STORAGE_ENGINE (M)

Here you can customize the storage engine of mongodb. Yambas needs the mmapv1 engine and this is also the default setting

USE_SMALL_FILES (M)

use mongodb small files option

REPL_SET (M)

This variable can be used to prepare a manual mongodb replication set. The initialization has to be done manually until now.

* link only available in Enterprise Documentation