Configure config.hjson

Kekkai can be configured using the config.hjson file in the working directory. config.example.hjson.

# For more information, see the documentation
# https://kekkai.redume.su/docs/

{
    database:
    {
      user: DATABASE_USERNAME
      password: DATABASE_PASSWORD
      host: localhost
      name: kekkai
      port: 5432
    }
    server:
    {
      host: 0.0.0.0
      log:
      {
        level: info
      }
    }
    analytics:
    {
      plausible_domain: plausible.io
      plausible_token: TOKEN
      enabled: false
    }
    currency:
    {
      collecting:
      {
        fiat: true
        crypto: false
        schedule: 30 8 * * *
        crypto_apikey: TOKEN
      }
      fiat:
      [
        USD
        RUB
        EUR
        UAH
        TRY
        KZT
      ]
      crypto:
      [
        ETH
        TON
        USDT
        BTC
      ]
    }
  }

Database

Kekkai is used as a PostgreSQL database.

If you installed Kekkai via Docker Compose, set it to database.host for postgres. The password (database.password) should be the same as in .env, the rest of the data doesn’t need to be filled in, it should be in .env

What should it look like:

database:
{
  ...
  password: PASSWORD_FROM_ENV
  host: postgres
  ...
}
...

Server

Analytics

Kekkai uses Plausbile as an analyst. Minimal data is transferred for anilithics. Such as: browser, OS, status code, url, where the user came from. Most of the data is built on User Agent. It is possible to disable analytics in Kekkai.

...
analytics:
    plausible_api: 'https://plausible.io/api/event/'
    plausible_domain: 'PLAUSIBLE_DOMAIN'
    plausible_token: 'PLAUSIBLE_TOKEN'
    enabled: true
...

plausible_api: This is where the Plausible instance is specified. The official instance is specified by default.
plausible_domain: Kekkai Instance Domain. It should be added to Plausible first, and then to the config. You can add the domain here.
plausible_token: Api token for authorization and sending requests. You can create it here.
enabled: Enable or disable analytics.

Currency

DuckDuckGo (fiat currency collection) and CoinMarketCap, ExchangeRatApi (cryptocurrency collection) are used to collect currency rates.

...
    currency: {
      services: {
        enabled: [
          'coinmarketcap'
        ]
        coinmarketcap: {
          "api_key": TOKEN_COINMARKETCAP"
          "base_url": https://pro-api.coinmarketcap.com/v1/cryptocurrency/quotes/latest
        }
        duckduckgo: {
          "base_url": https://duckduckgo.com/js/spice/currency/1/
        }
        exchangeratapi: {
          api_key: TOKEN_EXCHANGERATE
          base_url: https://v6.exchangerate-api.com/v6/
        }
      }
      fiat:
      [
        USD,
        RUB,
        EUR,
        UAH,
        TRY,
        KZT,
        CNY
        ]
        crypto:
        [
          ETH,
          BTC,
          USDT,
          TON
        ]
    }
    schedule: 30 8 * * *

currency.service.enabled: List of services that will collect data.
currency.schedule: Currency collection interval (Configurable via cron. It is recommended to use crontab.guru, not supported in Non-standard format, like @daily).
currency.fiat: A list of fiat currencies that will be saved to the database.
currency.crypto: A list of crypto currencies that will be saved to the database.