Skip to content

System Administration

Guidelines for system administrators to manage and maintain the project.

Environment Variables

The following environment variables must be configured in the .env file:

  • PORT: The port on which the service will run (e.g., 4000).
  • APP_NAME: The name of the application (e.g., alarmsService).
  • APP_VERSION: The version of the application (e.g., 1.0.0).
  • SERVICE_API_KEY: The API key for the service.
  • APP_ENVIRONMENT: The environment in which the application is running (e.g., testing).

Database Configuration

  • DATASOURCE_FQDN: Fully qualified domain name of the PostgreSQL database.
  • SERVICE_BD_NAME: Name of the database.
  • SERVICE_BD_SCHEMA: Schema used in the database.
  • DATASOURCE_USR: Database username.
  • DATASOURCE_PWD: Database password.
  • SERVICE_BD_SSL: SSL requirement for the database connection (e.g., require).

Database Requirements

This service requires a PostgreSQL database. Ensure the database is properly configured and accessible using the credentials and settings specified in the .env file.