Skip to content

Configuration Reference

This page summarizes the most important configuration surfaces.

Frontend Environment Variables

VariableDefaultDescription
VITE_LOCKED_SERVER_URLunsetLocks the frontend to exactly one StarQuery server.
VITE_LOCKED_SERVER_NAMEConfigured ServerLabel used for the locked server.
VITE_DEFAULT_SERVER_URLunsetDefault remote server URL for the plain web frontend.
VITE_APP_BASE_URLhttp://127.0.0.1:3000Fallback backend URL for development.

Backend Core

VariableDefaultDescription
STARQUERY_MODEhostedRuntime mode: hosted or local.
HOST0.0.0.0HTTP bind host.
PORT3000HTTP port.
STARQUERY_SERVER_NAMEdepends on modeDisplay name returned by the backend.
STARQUERY_REQUEST_BODY_LIMIT100mbRequest size limit.

Metastore

VariableDefaultDescription
STARQUERY_META_DRIVERmysql in hosted, sqlite in localMetastore driver.
STARQUERY_META_SQLITE_PATH<cwd>/.starquery/starquery-meta.sqliteSQLite path.
STARQUERY_META_MYSQL_HOST127.0.0.1MySQL host.
STARQUERY_META_MYSQL_PORT3307MySQL port.
STARQUERY_META_MYSQL_USERstarqueryMySQL user.
STARQUERY_META_MYSQL_PASSWORDstarqueryMySQL password.
STARQUERY_META_MYSQL_DATABASEstarqueryMySQL database name.

Auth

VariableDefaultDescription
STARQUERY_AUTH_SESSION_TTL_HOURS720Session lifetime.
STARQUERY_AUTH_API_KEY_TTL_DAYS365API key lifetime.

CORS and Public URL

VariableDefaultDescription
STARQUERY_PUBLIC_URLunsetPublic hosted URL used for same-origin redirects and hosted behavior.
STARQUERY_CORS_ALLOWED_ORIGINSunsetComma-separated extra allowed origins in hosted mode.

Bootstrap and Seed Admin

VariableDefaultDescription
STARQUERY_BOOTSTRAP_CONFIG_PATHunsetBootstrap JSON path.
STARQUERY_SEED_ADMIN_EMAILunsetSeed admin email.
STARQUERY_SEED_ADMIN_PASSWORDunsetSeed admin password.
STARQUERY_SEED_ADMIN_NAMEAdminSeed admin display name.

OpenID Connect

VariableDefaultDescription
STARQUERY_AUTH_OPENID_ISSUERunsetOpenID issuer URL.
STARQUERY_AUTH_OPENID_CLIENT_IDunsetClient ID.
STARQUERY_AUTH_OPENID_CLIENT_SECRETunsetClient secret.
STARQUERY_AUTH_OPENID_SCOPESopenid profile emailRequested scopes.

For deeper narrative guidance, also see Hosted Configuration.