SimpleX Directory Servers Validator

Backend service and performs scheduled validation of servers in SimpleX Directory.

Frontend repository: simplex-directory-frontend

How to run

The project uses Supabase as storage for servers and their status history. So you should setup Supabase project first using the instruction below. When the project is up and running, you should setup a validator which will go through servers list in the database and write status history by schedule. There are two ways to do that: run locally (e.g. if you want to self-host it); or run on GitHub Acions.

Setup Supbase project

1. Setup Supabase account, create project
2. Run init_db.sql in public schema (e.g using SQL editor page in Supabase project)

Run locally

1. Fill variables in .env
2. Run make validate by schedule. It's up to you how to organize an automated trigger. For example, you an use cron or systemd.timer

Run on GitHub Actions

1. Fill variables in .env
2. Create ENV_FILE_CONTENT repository secret (instruction), value of the secret is content of filled out .env file
3. Done. The validator will run by schedule. You can dispatch the workflow manually in Actions sections of a repository