Skip to main content
Version: Next
info

Please note that this content is under development and is not ready for implementation. This status message will be updated as content development progresses.

Configuration

This section outlines where the configuration for the Identity Resolver Service (IDR) is stored and details the environment variables used to manage its behavior.

Location

The configuration for the Identity Resolver Service (IDR) is stored in environment-specific files located in the project’s app directory. These files are used to define environment variables based on the application’s runtime environment, which is determined by the NODE_ENV variable. The files are:

  • .env.development.local and .env.development for the development environment.
  • .env.test.local and .env.test for the test environment.
  • .env.production.local and .env.production for the production environment.
    The .env.[environment].local files take precedence over the corresponding .env.[environment] files, allowing for local overrides without affecting the base configuration.

Core Variables

VariableDescription
NODE_ENVSpecifies the environment (development, test, production)
RESOLVER_DOMAINThe base URL of the resolver service
PORTThe port the resolver service is exposed to
APP_NAMEThe name of the application
API_KEYAPI key for authentication
LINK_TYPE_VOC_DOMAINThe base URL of the link type vocabulary endpoint

Object Storage Configuration

VariableDescription
OBJECT_STORAGE_ENDPOINTThe MinIO server endpoint or object storage endpoint
OBJECT_STORAGE_PORTThe MinIO server port. If using object storage, not required
OBJECT_STORAGE_USE_SSLWhether to use SSL for MinIO connections
OBJECT_STORAGE_ACCESS_KEYThe MinIO access key or cloud provider access key
OBJECT_STORAGE_SECRET_KEYThe MinIO secret key or cloud provider secret key
OBJECT_STORAGE_PATH_STYLEEnable or disable path-style requests for MinIO. Set to false for cloud providers. Set to true if you are using MinIO Gateway. By default, it is set to true
OBJECT_STORAGE_BUCKET_NAMEName of the MinIO bucket to use

Other Configuration

VariableDescription
IDENTIFIER_PATHPath for identifier-related operations

NODE_ENV

The NODE_ENV variable is crucial for determining which environment variable files are loaded by the application:

  • development: Loads the environment variables from .env.development.local and .env.development.
  • test: Loads the environment variables from .env.test.local and .env.test.
  • production: Loads the environment variables from .env.production.local and .env.production.