Sankofa Docs
Open app
DocsSelf-hostingEnvironment reference
Self-hosting

Environment reference

Reference for the engine configuration surface in the checked-in .env example.

Source of truthserver/engine/.env.example

Core app settings

FieldTypeRequiredDescription
APP_URLstringYesBase URL for the engine, such as http://localhost:8080.
APP_PORTstringYesPort the Sankofa engine listens on.
LOG_LEVELstringNoApplication log level.
CORS_ALLOWED_ORIGINSstringNoAllowed frontend origins for browser access.

Database and analytics settings

FieldTypeRequiredDescription
SQLITE_FILEstringNoPath to the SQLite metadata database.
CLICKHOUSE_ADDRstringNoClickHouse host and native port.
CLICKHOUSE_DBstringNoClickHouse database name.
CLICKHOUSE_USERstringNoClickHouse username.
CLICKHOUSE_PASSWORDstringNoClickHouse password.

Bootstrap and security

FieldTypeRequiredDescription
API_SECRETstringNoJWT and session secret used by the API layer.
ADMIN_EMAILstringNoInitial admin email for bootstrapping the installation.
ADMIN_PASSWORDstringNoInitial admin password.
ADMIN_ORG_NAMEstringNoInitial organization name.
ADMIN_PROJECT_NAMEstringNoInitial project name.
GEOIP_DB_PATHstringNoPath to the GeoLite2 City database used for IP resolution.

Storage and outbound services

FieldTypeRequiredDescription
B2_PUBLIC_ENDPOINTstringNoPublic storage endpoint value in the checked-in example.
B2_PUBLIC_BUCKET_NAMEstringNoPublic bucket name.
B2_PUBLIC_KEY_IDstringNoPublic bucket key identifier.
B2_PUBLIC_APP_KEYstringNoPublic bucket application key.
RESEND_API_KEYstringNoResend API key for email delivery.
MAILERSEND_API_KEYstringNoMailersend API key for email delivery.
EMAIL_FROM_ADDRESSstringNoDefault outbound email address.
EMAIL_FROM_NAMEstringNoDefault outbound email name.
FRONTEND_URLstringNoPrimary frontend URL used by the engine.

Previous

Docker Compose deployment

Bring up Sankofa and ClickHouse locally using the compose file included in the repository.

Next

Production architecture

Understand the role of the engine, SQLite, ClickHouse, and enterprise plugins in a self-hosted deployment.