Skip to content

Administration

Deployment

To deploy the Neat Service, follow these steps:

  1. Ensure all environment variables are configured in the .env file.

  2. Build the Docker image: 

    docker-compose build

  3. Start the container: 

    docker-compose up

System Administration

Environment Variables

  • PORT: The port on which the service runs.
  • APP_NAME: The name of the application.
  • APP_VERSION: The version of the application.
  • SERVICE_API_KEY: The API key for authentication.
  • DATASOURCE_FQDN: The fully qualified domain name of the database.
  • SERVICE_BD_NAME: The name of the database.
  • SERVICE_BD_SCHEMA: The schema name in the database.
  • DATASOURCE_USR: The database user.
  • DATASOURCE_PWD: The database password.
  • SERVICE_BD_SSL: The SSL mode for the database connection.
  • INTERVAL_FEEDBACK_TEST_API: Interval for feedback test API (in milliseconds).
  • INTERVAL_DEVICE_STATUS: Interval for device status updates (in milliseconds).
  • INTERVAL_DEVICE_STATUS_ESPERA: Interval for device status espera (in milliseconds).
  • INTERVAL_ALL_DEVICE: Interval for all devices (in milliseconds).
  • INTERVAL_DEVICE_WATCHERS: Interval for device watchers (in milliseconds).
  • INTERVAL_DEVICE_WATCHERS_TIMEOUT: Timeout interval for device watchers (in milliseconds).
  • INTERVAL_REFRESHTOKEN: Interval for refresh token (in milliseconds).
  • INTERVAL_DEVICE_INTERNAL_CONSULT: Interval for device internal consult (in milliseconds).
  • INTERVAL_DEVICE_SYNC_INFO: Interval for device sync info (in milliseconds).
  • PROXY_URL: Proxy URL if needed (leave empty if not used).
  • SERVICE_NEAT_KEY: The API key for the Neat service (ensure no leading/trailing spaces).
  • SERVICE_NEAT_ORG_ID: The organization ID for the Neat service.
  • SERVICE_NEAT_API_URL: The API URL for the Neat service (ensure no leading/trailing spaces).

Logs

Logs are printed to the console. In production, it is recommended to redirect logs to a file or a logging service.