Environment Variables and Configs
Tyk Identity Broker Configuration Options
The Tyk Identity Broker (TIB) is configured through two files: The configuration file The
tib.conf and the profiles file profiles.json. TIB can also be managed via the TIB REST API for automated configurations.
The tib.conf file
Omitting the configuration file
From TIB v1.3.1, the environment variableTYK_IB_OMITCONFIGFILE is provided to allow the configuration file to be omitted (ignored) when configuring TIB.
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
The REST API secret to configure the Tyk Identity Broker remotely. (env var:TYK_IB_SECRET)ProfileDir
Directory where the backup files will be stored. Backups files are created each time that a create, update or delete action is performed over any profile (and profiles are being read from a file not from mongo, in which case it will create a new document in theprofiles_backup collection).
(env var:TYK_IB_PROFILEDIR)
HttpServerOptions.UseSSL
Set this totrue to turn on SSL for the server, this is highly recommended.
(env var:TYK_IB_HTTPSERVEROPTIONS_USESSL)
HttpServerOptions.KeyFile
The path to the key file for this server, required for SSL. (env var:TYK_IB_HTTPSERVEROPTIONS_KEYFILE)HttpServerOptions.CertFile
The path to the certificate file for this server, required for SSL. (env var:TYK_IB_HTTPSERVEROPTIONS_CERTFILE)BackEnd
TIB is quite modular and different back-ends can be generated quite easily. By default, TIB will store profile configurations in memory, which does not require any new configuration. For Identity Handlers that provide token-based access, it is possible to enforce a “One token per provider, per user” policy, which keeps a cache of tokens assigned to identities in Redis, this is so that the broker can be scaled and share the cache across instances. Since profiles are unlikely to change often, profiles are kept in-memory, but can be added, removed and modified using an API for automated setups if required.BackEnd.IdentityBackendSettings.Database
If you are using multiple databases (not supported in Redis cluster), let TIB know which DB to use for Identity caching. (env var:TYK_IB_BACKEND_IDENTITYBACKENDSETTINGS_DATABASE)BackEnd.IdentityBackendSettings.Username
The username for Redis AUTH, if used (recommended). (env var:TYK_IB_BACKEND_IDENTITYBACKENDSETTINGS_USERNAME)BackEnd.IdentityBackendSettings.Password
The password for your Redis AUTH Username. (env var:TYK_IB_BACKEND_IDENTITYBACKENDSETTINGS_PASSWORD)BackEnd.IdentityBackendSettings.Hosts
Add your Redis hosts here as a map of hostname:port. Since TIB uses the same cluster driver as Tyk, it is possible to have TIB interact with your existing Redis cluster if you enable it. (env var:TYK_IB_BACKEND_IDENTITYBACKENDSETTINGS_HOSTS)To set this value via env var you must follow the declaration syntax
export TYK_IB_BACKEND_IDENTITYBACKENDSETTINGS_HOSTS="host1:port,host2:port"BackEnd.IdentityBackendSettings.MaxIdle
Max idle connections to Redis. (env var:TYK_IB_BACKEND_IDENTITYBACKENDSETTINGS_MAXIDLE)BackEnd.IdentityBackendSettings.MaxActive
Max active Redis connections. (env var:TYK_IB_BACKEND_IDENTITYBACKENDSETTINGS_MAXACTIVE)BackEnd.IdentityBackendSettings.EnableCluster
If you are using Redis cluster, enable it here to enable the slots mode. (env var:BackEnd.IdentityBackendSettings.EnableCluster)BackEnd.IdentityBackendSettings.UseSSL
If you are using a TLS protected Redis enable to connect. (env var:TYK_IB_BACKEND_IDENTITYBACKENDSETTINGS_USESSL)This option is available from TIB v0.4.0
BackEnd.IdentityBackendSettings.SSLInsecureSkipVerify
Allows usage of self-signed certificates when connecting to an encrypted Redis database. (env var:TYK_IB_BACKEND_IDENTITYBACKENDSETTINGS_SSLINSECURESKIPVERIFY)This option is available from TIB v0.4.0
TykAPISettings
This section enables you to configure the API credentials for the various Tyk Components TIB is interacting with. (env var:TYK_IB_TYKAPISETTINGS)TykAPISettings.GatewayConfig.Endpoint
The hostname of the Tyk Gateway (this is for token generation purposes). (env var:TYK_IB_TYKAPISETTINGS_GATEWAYCONFIG_ENDPOINT)TykAPISettings.GatewayConfig.Port
The port to use on the Tyk Gateway host. (env var:TYK_IB_TYKAPISETTINGS_GATEWAYCONFIG_PORT)For HTTP or HTTPS endpoints, you do need need to specify the default ports (80 and 443) for this setting. These two ports are handled automatically.