Platform

The Platform API and web interface are released as a single container image(opens in new tab). Provide a separate PostgreSQL database, an SMTP server, and an HTTPS reverse proxy for public access. Compute runs your Solutions and is installed separately.

bash
docker run ghcr.io/xlonglink/longlink:latest

Environment variables

See the environment example(opens in new tab) for their settings.

Environment variables
PUBLIC_URLstring · default: http://localhost:5173
Public HTTPS origin without a path. HTTP is allowed only for loopback development.
SESSION_KEYstring · required
Session signing secret with at least 32 characters. Keep stable across restarts and replicas.
ENCRYPTION_KEYstring · required
Encrypts stored infrastructure credentials. At least 32 characters; retain and back up this key.
ADMIN_EMAILemail · required
Platform administrator email. The sole administrator is reconciled on startup.
ADMIN_PASSWORDstring · required
Platform administrator password, reconciled on startup. Use a strong password.
DATABASE_URLstring · required
Platform database connection URL, including its asynchronous driver, credentials, and database name.
SMTP_HOSTstring · required
SMTP server for account verification and password reset emails.
SMTP_PORTinteger · default: 587
SMTP server port, from 1 to 65535.
SMTP_TRANSPORT"plain" | "starttls" | "tls" · default: starttls
SMTP connection security. Use starttls or tls for hosted deployments.
SMTP_FROMemail · default: no-reply@longlink.dev
Sender address. Configure an address your SMTP provider permits.
SMTP_USERNAMEstring · optional
SMTP authentication username. Configure together with SMTP_PASSWORD or omit both.
SMTP_PASSWORDstring · optional
SMTP authentication password. Requires SMTP_USERNAME.
GOOGLE_OAUTH_CLIENT_IDstring · optional
Enables Google sign-in when configured with GOOGLE_OAUTH_CLIENT_SECRET.
GOOGLE_OAUTH_CLIENT_SECRETstring · optional
Google OAuth client secret. Requires GOOGLE_OAUTH_CLIENT_ID.
GITHUB_OAUTH_CLIENT_IDstring · optional
Enables GitHub sign-in when configured with GITHUB_OAUTH_CLIENT_SECRET.
GITHUB_OAUTH_CLIENT_SECRETstring · optional
GitHub OAuth client secret. Requires GITHUB_OAUTH_CLIENT_ID.
STRIPE_SECRET_KEYstring · optional
Stripe secret or restricted API key. Configure with STRIPE_WEBHOOK_SECRET to enable payments.
STRIPE_WEBHOOK_SECRETstring · optional
Stripe webhook signing secret beginning with whsec_. Requires STRIPE_SECRET_KEY.