diff --git a/product-stack/tyk-enterprise-developer-portal/deploy/configuration.mdx b/product-stack/tyk-enterprise-developer-portal/deploy/configuration.mdx index c5b52fb7a..915d87bea 100644 --- a/product-stack/tyk-enterprise-developer-portal/deploy/configuration.mdx +++ b/product-stack/tyk-enterprise-developer-portal/deploy/configuration.mdx @@ -5,8 +5,13 @@ keywords: "Configure Tyk Enterprise Developer Portal, Tyk Enterprise Developer P sidebarTitle: "Environment Variables and Configs" --- +import EnvTypeMapping from '/snippets/env-type-mapping.mdx'; + To configure the Tyk Enterprise Developer Portal, you can use either a config file or environment variables. The table below provides a reference to all options available to you when configuring the portal. + + + ## Portal settings This section explains the general portal settings, including which port it will be listening on, how often it should synchronize API Products and plans with the Tyk Dashboard, and so on. Most of these settings are optional, except for the PORTAL_LICENSEKEY. If you don't specify these settings, the default values will be used. diff --git a/snippets/env-type-mapping.mdx b/snippets/env-type-mapping.mdx new file mode 100644 index 000000000..df0ad3c98 --- /dev/null +++ b/snippets/env-type-mapping.mdx @@ -0,0 +1,16 @@ +### Environment Variable Type Mapping + +When configuring Tyk components using environment variables, it's important to understand how different data types are represented. The type of each variable is based on its definition in the Go source code. This section provides a guide on how to format values for common data types. + +| Go Type | Environment Variable Format | Example | +| ----------------------- | ---------------------------------- | -------------------------------------------------------------------- | +| `string` | A regular string of text. | `TYK_GW_SECRET="mysecret"` | +| `int`, `int64` | A whole number. | `TYK_GW_LISTENPORT=8080` | +| `bool` | `true` or `false`. | `TYK_GW_USEDBAPPCONFIG=true` | +| `[]string` | A comma-separated list of strings. | `TYK_PMP_PUMPS_STDOUT_FILTERS_SKIPPEDAPIIDS="api1,api2,api3"` | +| `map[string]string` | A comma-separated list of key:value pairs. | `TYK_GW_GLOBALHEADERS="X-Tyk-Test:true,X-Tyk-Version:1.0"` | +| `map[string]interface{}` | A JSON string representing the object. | `TYK_GW_POLICIES_POLICYSOURCE_CONFIG='{"connection_string": "..."}'` | + + +For complex types like `map[string]interface{}`, the value should be a valid JSON string. For `[]string` and `map[string]string`, ensure there are no spaces around the commas unless they are part of the value itself. + diff --git a/tyk-configuration-reference/tyk-identity-broker-configuration.mdx b/tyk-configuration-reference/tyk-identity-broker-configuration.mdx index 69bc31c94..5e19cec0f 100644 --- a/tyk-configuration-reference/tyk-identity-broker-configuration.mdx +++ b/tyk-configuration-reference/tyk-identity-broker-configuration.mdx @@ -5,9 +5,11 @@ order: 3 sidebarTitle: "Tyk Identity Broker" --- +import EnvTypeMapping from '/snippets/env-type-mapping.mdx'; + The Tyk Identity Broker (TIB) is configured through two files: The configuration file `tib.conf` and the profiles file `profiles.json`. TIB can also be managed via the [TIB REST API](/tyk-identity-broker/tib-rest-api) for automated configurations. -#### The `tib.conf` file +### The `tib.conf` file ```{.copyWrapper} { @@ -56,6 +58,8 @@ From TIB v1.3.1, the environment variable `TYK_IB_OMITCONFIGFILE` is provided to If set to TRUE, then TIB will ignore any provided configuration file and set its parameters according to environment variables. TIB will fall back to the default value for any parameters not set in an environment variable. This is particularly useful when using Docker, as this option will ensure that TIB will load the configuration via env vars and not expect a configuration file. + + The various options for `tib.conf` file are: ### secret diff --git a/tyk-dashboard/configuration.mdx b/tyk-dashboard/configuration.mdx index 66dd003c1..66d98e8d4 100644 --- a/tyk-dashboard/configuration.mdx +++ b/tyk-dashboard/configuration.mdx @@ -6,6 +6,7 @@ sidebarTitle: "Dashboard" --- import DashboardConfig from '/snippets/dashboard-config.mdx'; +import EnvTypeMapping from '/snippets/env-type-mapping.mdx'; You can use environment variables to override the config file for the Tyk Dashboard. The Dashboard configuration file can be found in the `tyk-dashboard` folder and by default is called `tyk_analytics.conf`, though it can be renamed and specified using the `--conf` flag. Environment variables are created from the dot notation versions of the JSON objects contained with the config files. To understand how the environment variables notation works, see [Environment Variables](/tyk-oss-gateway/configuration). @@ -20,6 +21,8 @@ Please consult the [data storage configuration](/api-management/dashboard-config All the Dashboard environment variables have the prefix `TYK_DB_`. The environment variables will take precedence over the values in the configuration file. + + Environment variables (env var) can be used to override the settings defined in the configuration file. Where an environment variable is specified, its value will take precedence over the value in the configuration file. The file will look like the sample below, the various fields are explained in the following sections: diff --git a/tyk-multi-data-centre/mdcb-configuration-options.mdx b/tyk-multi-data-centre/mdcb-configuration-options.mdx index 32c58d1a5..387987607 100644 --- a/tyk-multi-data-centre/mdcb-configuration-options.mdx +++ b/tyk-multi-data-centre/mdcb-configuration-options.mdx @@ -7,6 +7,7 @@ sidebarTitle: "Multi Data Center Bridge" --- import MdcbConfig from '/snippets/mdcb-config.mdx'; +import EnvTypeMapping from '/snippets/env-type-mapping.mdx'; ## Tyk MDCB Configuration @@ -16,6 +17,8 @@ The Tyk MDCB server is configured primarily via the `tyk_sink.conf` file, this f Environment variables (env var) can be used to override the settings defined in the configuration file. Where an environment variable is specified, its value will take precedence over the value in the configuration file. + + ### Default Ports | Application | Port | diff --git a/tyk-oss-gateway/configuration.mdx b/tyk-oss-gateway/configuration.mdx index 8cbdf5366..5417ec0cc 100644 --- a/tyk-oss-gateway/configuration.mdx +++ b/tyk-oss-gateway/configuration.mdx @@ -6,12 +6,15 @@ sidebarTitle: "Gateway" --- import GatewayConfig from '/snippets/gateway-config.mdx'; +import EnvTypeMapping from '/snippets/env-type-mapping.mdx'; You can use environment variables to override the config file for the Tyk Gateway. The Gateway configuration file can be found in the `tyk-gateway` folder and by default is called `tyk.conf`, though it can be renamed and specified using the `--conf` flag. Environment variables are created from the dot notation versions of the JSON objects contained with the config files. To understand how the environment variables notation works, see [Environment Variables](/tyk-oss-gateway/configuration). All the Gateway environment variables have the prefix `TYK_GW_`. The environment variables will take precedence over the values in the configuration file. + + ### tyk lint In **v2.4** we have added a new `tyk lint` command which will validate your `tyk.conf` file and validate it for syntax correctness, misspelled attribute names or format of values. The Syntax can be: diff --git a/tyk-pump/tyk-pump-configuration/tyk-pump-environment-variables.mdx b/tyk-pump/tyk-pump-configuration/tyk-pump-environment-variables.mdx index d447646b1..428202d94 100644 --- a/tyk-pump/tyk-pump-configuration/tyk-pump-environment-variables.mdx +++ b/tyk-pump/tyk-pump-configuration/tyk-pump-environment-variables.mdx @@ -7,10 +7,13 @@ sidebarTitle: "Pump" --- import PumpConfig from '/snippets/pump-config.mdx'; +import EnvTypeMapping from '/snippets/env-type-mapping.mdx'; You can use environment variables to override the config file for the Tyk Pump. Environment variables are created from the dot notation versions of the JSON objects contained with the config files. To understand how the environment variables notation works, see [Environment Variables](/tyk-oss-gateway/configuration). All the Pump environment variables have the prefix `TYK_PMP_`. The environment variables will take precedence over the values in the configuration file. + +