Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/fatelessdev/translogiX/llms.txt

Use this file to discover all available pages before exploring further.

TranslogiX reads its runtime configuration from environment variables. This page lists every variable the application recognises, whether it is required or optional, and what degrades gracefully when an optional variable is not set.

​
Variable reference

VariableRequiredDescription
DATABASE_URLYesPostgreSQL connection string used by both the application and Drizzle Kit tooling.
BETTER_AUTH_SECRETYesSecret key used by BetterAuth to sign and verify session tokens. Use a long random string.
BETTER_AUTH_URLYesBase URL of your deployed application (e.g. https://app.example.com). BetterAuth uses this to construct absolute callback URLs.
NEXT_PUBLIC_GOOGLE_MAPS_API_KEYNoBrowser-side Google Maps API key. Enables the live map in the AI Ops dashboard. When omitted, a placeholder message is shown in place of the map; GPS data is still collected.
GOOGLE_ROUTES_API_KEYNoServer-side Google Routes API key. Enables real-time traffic data for route recommendations. When omitted, traffic levels are estimated from historical data.
OPENWEATHER_API_KEYNoOpenWeather API key. Enables live weather conditions for route recommendations. When omitted, weather conditions are estimated.
The NEXT_PUBLIC_ prefix on NEXT_PUBLIC_GOOGLE_MAPS_API_KEY means the value is embedded in the client-side bundle. Keep all other keys server-side only and never prefix them with NEXT_PUBLIC_.

​
Optional integrations and graceful degradation

The AI Ops dashboard in TranslogiX shows the live status of each integration using badges. When a key is missing:
  • Google Maps — The map panel displays a notice reading “Add NEXT_PUBLIC_GOOGLE_MAPS_API_KEY to render the actual Google Map.” Shipment GPS coordinates are still tracked and surfaced in the text list below the panel.
  • Google Routes — Route recommendations fall back to estimated traffic levels. The badge reads “Traffic estimated” instead of “Google traffic live”.
  • OpenWeather — Route recommendations fall back to estimated weather conditions. The badge reads “Weather estimated” instead of “Weather live”.
All core features — shipment management, vehicle tracking, user administration, and reporting — work without any of the optional keys.

​
Sample .env file

# ── Required ──────────────────────────────────────────────────────────────────

# PostgreSQL connection string (matches the Docker Compose default)
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/translogix

# BetterAuth — generate a strong random value, e.g. openssl rand -hex 32
BETTER_AUTH_SECRET=replace_with_a_long_random_secret

# Base URL of the application (no trailing slash)
BETTER_AUTH_URL=http://localhost:3000

# ── Optional — AI Ops integrations ───────────────────────────────────────────

# Live Google Map in the AI Ops dashboard (browser-side key)
NEXT_PUBLIC_GOOGLE_MAPS_API_KEY=

# Real-time traffic data for route recommendations (server-side key)
GOOGLE_ROUTES_API_KEY=

# Live weather data for route recommendations
OPENWEATHER_API_KEY=
Never commit your .env file to version control. Add it to .gitignore and share credentials through a secrets manager or your hosting platform’s environment variable settings.
Generate a strong BETTER_AUTH_SECRET with: openssl rand -hex 32

Build docs developers (and LLMs) love

Get started for freeTalk to us