api3/airseeker repository overview

⁠Airseeker

This is a copy of the README in the source repository for this application: https://github.com/api3dao/airseeker⁠

⁠Installation

yarn install

⁠Build

yarn build

⁠Configuration

You need to create a configuration file config/config.json. Take a look at config/config.example.json for an example configuration file. You can use string interpolation (with ${VAR} syntax) for providing secrets. Secrets are read from the environment variables. When running locally, either just with yarn start or via process manager, secrets are automatically loaded from config/secrets.env file. Take a look at config/secrets.example.env for an example secrets file.

⁠Usage

yarn start

⁠Running with process mamnager

You can use PM2⁠ process manager to run Airseeker. PM2 is also used in the Dockerized⁠ version.

# Starting Airseeker
yarn pm2:start
# PM2 status
yarn pm2:status
# Logs
yarn pm2:logs
# Stopping Airseeker
yarn pm2:stop

⁠Docker

The container is running the Airseeker with the PM2⁠ process manager and running a cronjob taking care of log rotation with logrotate⁠. We're using a default generated logrotate configuration from PM2⁠.

⁠Build

yarn docker:build

Resulting image is named api3/airseeker.