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


NOTE: The documentation is very new and may contain some gaps, please help us fill them in by opening issues or better yet, pull-requests when you think something could be explained better.


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.


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


The configuration below is just an example and not recommended for production use.
  "database": {
    "host": "",
    "user": "logchimp",
    "password": "password",
    "name": "logchimp-database",
    "port": 1001,
    "ssl": false
  "server": {
    "port": 3000,
    "secretKey": "Diq1-Xir9"
  // ...


LogChimp uses SMPT connection for sending emails programmatically.

  // ...
  "mail": {
    "service": "awesomeMail",
    "host": "",
    "user": "",
    "password": "strong-password",
    "port": 587

Does LogChimp support SMPT connection URL?

No, currently it's not supported. But you're most welcome to submit a feature request anytime.