How to access to configuration values from the code

Page summary:

Access configuration values loaded on startup using the strapi.config.get() method with dot notation for nested keys across all configuration files.

All the configuration files are loaded on startup and can be accessed through the strapi.config configuration provider.

If the /config/server.ts|js file has the following configuration:

JavaScript

module.exports = {
  host: '0.0.0.0',
};

TypeScript

export default {
  host: '0.0.0.0',
};

then the server.host key can be accessed as:

strapi.config.get('server.host', 'defaultValueIfUndefined');

Nested keys are accessible with the dot notation.

Note

The filename is used as a prefix to access the configurations.

Configuration files can either be .js, .ts, or .json files.

When using a .js or .ts file, the configuration can be exported:

• either as an object:

  JavaScript

  module.exports = {
    mySecret: 'someValue',
  };

  TypeScript

  export default {
    mySecret: 'someValue',
  };

• or as a function returning a configuration object (recommended usage). The function will get access to the env utility:

  JavaScript

  module.exports = ({ env }) => {
    return {
      mySecret: env('MY_SECRET_KEY', 'defaultSecretValue'),
    };
  };

  TypeScript

  export default ({ env }) => {
    return {
      mySecret: env('MY_SECRET_KEY', 'defaultSecretValue'),
    };
  };