Configuration

Step by step guide for you to configure LogChimp site using logchimp.config.json file.

Overview

A custom configuration file must be a valid JSON file located in the root folder. When you install LogChimp using LogChimp CLI, a configuration file is created with the options provided. There are some configuration options which are required by default, and few options configuration.

The two required options are database and server which are configurated during installation process.

In article explains about each configuration and its uses.

Node environment

LogChimp supports three environments: development, testing, production. A public LogChimp site should always run in production mode, development is used for building LogChimp locally and testing is only used in CI/CD to run tests.

Options

There are number of options which are explained in detail below.

alert

The configuration below is just an example and not recommended for production use.
{
  "database": {
    "host": "database.domain.com/postgresql",
    "user": "logchimp",
    "password": "password",
    "name": "logchimp-database",
    "port": 1001,
    "ssl": false
  },
  "server": {
    "port": 3000,
    "secretKey": "Diq1-Xir9"
  },
  "mail": {
    "service": "awesomeMail",
    "host": "smtp.domain.com",
    "user": "mail@sub-domain.domain.com",
    "password": "strong-password",
    "port": 587
  }
}