Documentation Documentation

Tyk Gateway Environment Variables

JSON Value Environment Variable Name
listen_address TYK_GW_LISTENADDRESS
listen_port TYK_GW_LISTENPORT
secret TYK_GW_SECRET
node_secret TYK_GW_NODESECRET
template_path TYK_GW_TEMPLATEPATH
tyk_js_path TYK_GW_TYKJSPATH
middleware_path TYK_GW_MIDDLEWAREPATH
policies.policy_source TYK_GW_POLICIES_POLICYSOURCE
policies.policy_connection_string TYK_GW_POLICIES_POLICYCONNECTIONSTRING
policies.policy_record_name TYK_GW_POLICIES_POLICYRECORDNAME
policies.allow_explicit_policy_id TYK_GW_POLICIES_ALLOWEXPLICITPOLICYID
use_db_app_configs TYK_GW_USEDBAPPCONFIGS
db_app_conf_options.connection_string TYK_GW_DBAPPCONFOPTIONS_CONNECTIONSTRING
db_app_conf_options.node_is_segmented TYK_GW_DBAPPCONFOPTIONS_NODEISSEGMENTED
db_app_conf_options.tags TYK_GW_DBAPPCONFOPTIONS_TAGS
disable_dashboard_zeroconf TYK_GW_DISABLEDASHBOARDZEROCONF
app_path TYK_GW_APPPATH
storage.type TYK_GW_STORAGE_TYPE
storage.host TYK_GW_STORAGE_HOST
storage.port TYK_GW_STORAGE_PORT
storage.hosts TYK_GW_STORAGE_HOSTS
storage.username TYK_GW_STORAGE_USERNAME
storage.password TYK_GW_STORAGE_PASSWORD
storage.database TYK_GW_STORAGE_DATABASE
storage.optimisation_max_idle TYK_GW_STORAGE_MAXIDLE
storage.optimisation_max_active TYK_GW_STORAGE_MAXACTIVE
storage.enable_cluster TYK_GW_STORAGE_ENABLECLUSTER
enable_separate_cache_store TYK_GW_ENABLESEPERATECACHESTORE
cache_storage.type TYK_GW_CACHESTORAGE_TYPE
cache_storage.host TYK_GW_CACHESTORAGE_HOST
cache_storage.port TYK_GW_CACHESTORAGE_PORT
cache_storage.hosts TYK_GW_CACHESTORAGE_HOSTS
cache_storage.username TYK_GW_CACHESTORAGE_USERNAME
cache_storage.password TYK_GW_CACHESTORAGE_PASSWORD
cache_storage.database TYK_GW_CACHESTORAGE_DATABASE
cache_storage.optimisation_max_idle TYK_GW_CACHESTORAGE_MAXIDLE
cache_storage.optimisation_max_active TYK_GW_CACHESTORAGE_MAXACTIVE
cache_storage.enable_cluster TYK_GW_CACHESTORAGE_ENABLECLUSTER
enable_analytics TYK_GW_ENABLEANALYTICS
analytics_config.type TYK_GW_ANALYTICSCONFIG_TYPE
analytics_config.ignored_ips TYK_GW_ANALYTICSCONFIG_IGNOREDIPS
analytics_config.enable_detailed_recording TYK_GW_ANALYTICSCONFIG_ENABLEDETAILEDRECORDING
analytics_config.enable_geo_ip TYK_GW_ANALYTICSCONFIG_ENABLEGEOIP
analytics_config.geo_ip_db_path TYK_GW_ANALYTICSCONFIG_GEOIPDBLOCATION
analytics_config.normalise_urls.enabled TYK_GW_NORMALISEURLS_ENABLED
analytics_config.normalise_urls.normalise_uuids TYK_GW_NORMALISEURLS_NORMALISEUUIDS
analytics_config.normalise_urls.normalise_numbers TYK_GW_NORMALISEURLS_NORMALISENUMBERS
analytics_config.normalise_urls.custom_patterns TYK_GW_NORMALISEURLS_CUSTOM
TYK_GW_COMPILEDPATTERNSET_UUIDS
TYK_GW_COMPILEDPATTERNSET_IDS
TYK_GW_COMPILEDPATTERNSET_CUSTOM
analytics_config.pool_size TYK_GW_ANALYTICSCONFIG_POOLSIZE
TYK_GW_ANALYTICSCONFIG_IGNOREDIPSCOMPILED
health_check.enable_health_checks TYK_GW_HEALTHCHECK_ENABLEHEALTHCHECKS
health_check.health_check_value_timeouts TYK_GW_HEALTHCHECK_HEALTHCHECKVALUETIMEOUT
optimisations_use_async_session_write TYK_GW_USEASYNCSESSIONWRITE
allow_master_keys TYK_GW_ALLOWMASTERKEYS
hash_keys TYK_GW_HASHKEYS
suppress_redis_signal_reload TYK_GW_SUPPRESSREDISSIGNALRELOAD
suppress_default_org_store TYK_GW_SUPRESSDEFAULTORGSTORE
use_redis_log TYK_GW_USEREDISLOG
sentry_code TYK_GW_SENTRYCODE
use_sentry TYK_GW_USESENTRY
use_syslog TYK_GW_USESYSLOG
use_graylog TYK_GW_USEGRAYLOG
use_logstash TYK_GW_USELOGSTASH
graylog_network_addr TYK_GW_GRAYLOGNETWORKADDR
logstash_network_addr TYK_GW_LOGSTASHNETWORKADDR
syslog_transport TYK_GW_SYSLOGTRANSPORT
logstash_transport TYK_GW_LOGSTASHTRANSPORT
syslog_network_addr TYK_GW_SYSLOGNETWORKADDR
enforce_org_data_age TYK_GW_ENFORCEORGDATAAGE
enforce_org_data_detail_logging TYK_GW_ENFORCEORGDATADEAILLOGGING
enforce_org_quotas TYK_GW_ENFORCEORGQUOTAS
experimental_process_org_off_thread TYK_GW_EXPERIMENTALPROCESSORGOFFTHREAD
enable_non_transactional_rate_limiter TYK_GW_ENABLENONTRANSACTIONALRATELIMITER
enable_sentinel_rate_limiter TYK_GW_ENABLESENTINELRATELIMITER
enable_redis_rolling_limiter TYK_GW_ENABLEREDISROLLINGLIMITER
monitor.enable_trigger_monitors TYK_GW_MONITOR_ENABLETRIGGERMONITORS
monitor.configuration.method TYK_GW_CONFIG_METHOD
monitor.configuration.target_path TYK_GW_CONFIG_TARGETPATH
monitor.configuration.template_path TYK_GW_CONFIG_TEMPLATEPATH
monitor.configuration.header_map TYK_GW_CONFIG_HEADERLIST
monitor.configuration.event_timeout TYK_GW_CONFIG_EVENTTIMEOUT
monitor.global_trigger_limit TYK_GW_MONITOR_GLOBALTRIGGERLIMIT
monitor.monitor_user_keys TYK_GW_MONITOR_MONITORUSERKEYS
monitor.monitor_org_keys TYK_GW_MONITOR_MONITORORGKEYS
oauth_refresh_token_expire TYK_GW_OAUTHREFRESHEXPIRE
oauth_token_expire TYK_GW_OAUTHTOKENEXPIRE
oauth_redirect_uri_separator TYK_GW_OAUTHREDIRECTURISEPARATOR
slave_options.use_rpc TYK_GW_SLAVEOPTIONS_USERPC
slave_options.connection_string TYK_GW_SLAVEOPTIONS_CONNECTIONSTRING
slave_options.rpc_key TYK_GW_SLAVEOPTIONS_RPCKEY
slave_options.api_key TYK_GW_SLAVEOPTIONS_APIKEY
slave_options.enable_rpc_cache TYK_GW_SLAVEOPTIONS_ENABLERPCCACHE
slave_options.bind_to_slugs TYK_GW_SLAVEOPTIONS_BINDTOSLUGSINSTEADOFLISTENPATHS
slave_options.disable_keyspace_sync TYK_GW_SLAVEOPTIONS_DISABLEKEYSPACESYNC
slave_options.group_id TYK_GW_SLAVEOPTIONS_GROUPID
slave_options.call_timeout TYK_GW_SLAVEOPTIONS_CALLTIMEOUT
disable_virtual_path_blobs TYK_GW_DISABLEVIRTUALPATHBLOBS
local_session_cache.disable_cached_session_state TYK_GW_LOCALSESSIONCACHE_DISABLECACHESESSIONSTATE
local_session_cache.cached_session_timeout TYK_GW_LOCALSESSIONCACHE_CACHEDSESSIONTIMEOUT
local_session_cache.cached_session_eviction TYK_GW_LOCALSESSIONCACHE_CACHESESSIONEVICTION
http_server_options.override_defaults TYK_GW_HTTPSERVEROPTIONS_OVERRIDEDEFAULTS
http_server_options.read_timeout TYK_GW_HTTPSERVEROPTIONS_READTIMEOUT
http_server_options.write_timeout TYK_GW_HTTPSERVEROPTIONS_WRITETIMEOUT
http_server_options.use_ssl TYK_GW_HTTPSERVEROPTIONS_USESSL
http_server_options.use_ssl_le TYK_GW_HTTPSERVEROPTIONS_USELE_SSL
http_server_options.enable_websockets TYK_GW_HTTPSERVEROPTIONS_ENABLEWEBSOCKETS
http_server_options.certificates TYK_GW_HTTPSERVEROPTIONS_CERTIFICATES
http_server_options.server_name TYK_GW_HTTPSERVEROPTIONS_SERVERNAME
http_server_options.min_version TYK_GW_HTTPSERVEROPTIONS_MINVERSION
http_server_options.flush_interval TYK_GW_HTTPSERVEROPTIONS_FLUSHINTERVAL
service_discovery.default_cache_timeout TYK_GW_SERVICEDISCOVERY_DEFAULTCACHETIMEOUT
close_connections TYK_GW_CLOSECONNECTIONS
auth_override.force_auth_provider TYK_GW_AUTHOVERRIDE_FORCEAUTHPROVIDER
auth_override.auth_provider.name TYK_GW_AUTHPROVIDER_NAME
auth_override.auth_provider.storage_engine TYK_GW_AUTHPROVIDER_STORAGEENGINE
auth_override.auth_provider.meta TYK_GW_AUTHPROVIDER_META
auth_override.force_session_provider TYK_GW_AUTHOVERRIDE_FORCESESSIONPROVIDER
auth_override.session_provider.name TYK_GW_SESSIONPROVIDER_NAME
auth_override.session_provider.storage_engine TYK_GW_SESSIONPROVIDER_STORAGEENGINE
auth_override.session_provider.meta TYK_GW_SESSIONPROVIDER_META
uptime_tests.disable TYK_GW_UPTIMETESTS_DISABLE
uptime_tests.config.failure_trigger_sample_size TYK_GW_CONFIG_FAILURETRIGGERSAMPLESIZE
uptime_tests.config.time_wait TYK_GW_CONFIG_TIMEWAIT
uptime_tests.config.checker_pool_size TYK_GW_CONFIG_CHECKERPOOLSIZE
uptime_tests.config.enable_uptime_analytics TYK_GW_CONFIG_ENABLEUPTIMEANALYTICS
hostname TYK_GW_HOSTNAME
enable_api_segregation (deprecated) TYK_GW_ENABLEAPISEGREGATION
control_api_port TYK_GW_CONTROLAPIPORT
control_api_hostname TYK_GW_CONTROLAPIHOSTNAME
enable_custom_domains TYK_GW_ENABLECUSTOMDOMAINS
enable_jsvm TYK_GW_ENABLEJSVM
coprocess_options.enable_coprocess TYK_GW_COPROCESSOPTIONS_ENABLECOPROCESS
coprocess_options.coprocess_grpc_server TYK_GW_COPROCESSOPTIONS_COPROCESSGRPCSERVER
hide_generator_header TYK_GW_HIDEGENERATORHEADER
event_handlers.events TYK_GW_EVENTHANDLERS_EVENTS
event_trigers_defunct TYK_GW_EVENTTRIGGERS
pid_file_location TYK_GW_PIDFILELOCATION
allow_insecure_configs TYK_GW_ALLOWINSECURECONFIGS
public_key_path TYK_GW_PUBLICKEYPATH
close_idle_connections TYK_GW_CLOSEIDLECONNECTIONS
drl_notification_frequency TYK_GW_DRLNOTIFICATIONFREQUENCY
global_session_lifetime TYK_GW_GLOBALSESSIONLIFETIME
force_global_session_lifetime TYK_GW_FORCEGLOBALSESSIONLIFETIME
bundle_base_url TYK_GW_BUNDLEBASEURL
enable_bundle_downloader TYK_GW_ENABLEBUNDLEDOWNLOADER
allow_remote_config TYK_GW_ALLOWREMOTECONFIG
legacy_enable_allowance_countdown TYK_GW_LEGACYENABLEALLOWANCECOUNTDOWN