Configuration Guide

Environment Configuration

• This app uses the config/config.yaml file for configuration. You can adjust the settings in this file according to your environment.
• Requires a Domain Utils Server aka : Routehub Link Domain Utils. You can use the provided docker-compose file for local development.
• Requires a PostgreSQL server for database operations and migrations.
• For local development, you can use the embedded PostgreSQL option. This will start an embedded PostgreSQL server for you.
• (Optional) Makefile is implemented for redis, postgresql container creation and serving the service.

Database Configuration

• services:
  • domain_utils_host: http://localhost:9001 The domain utils server host.
• host: The hostname of your database server.
• port: The port number on which your database server is listening.
• user: The username for your database.
• password: The password for your database.
• database: The name of your database.
• application_name: The name of your application.
• type: Configuration for database migration and seeding.
  • migrate: If set to true, the database schema will be migrated upon application startup.
  • seed: If set to true, the database will be seeded with initial data upon application startup.
  • provider: The database provider. Set this to embed for an embedded database.
• seed: Configuration for database seeding.
  • admin: Admin User data
  • organization: Default Organization data
  • domain: Default Domain data

GraphQL Configuration

• port: The port number on which your GraphQL server will run.
• playground: If set to true, the GraphQL playground will be enabled. This is useful for development and testing.
• dataloader: Configuration for the GraphQL data loader.
  • wait: The maximum duration to wait before dispatching a batch load.
  • cache: If set to true, the data loader will cache data.
  • lrue: Configuration for the Least Recently Used (LRU) cache. (Does not related to wait)
    • size: The maximum number of items that can be stored in the cache.
    • expire: The duration after which an item in the cache will expire.