Skip to content

Environment & deployment

This page collects the environment variables and ports operators need to run AzScraper. Integrators calling a hosted API only need the base URL and an API key or JWT — you can skip this page.

API process

Variable Role
API_PORT Listen port (default 3001 if unset).
JWT_SECRET Secret used to sign and verify Bearer tokens (32+ chars).
MONGODB_URI MongoDB connection string (jobs, projects, users).
MONGODB_DATABASE Optional database-name override when not encoded in MONGODB_URI.
REDIS_URL Redis connection for the BullMQ crawl queue (or set REDIS_HOST / REDIS_PORT / REDIS_PASSWORD).

Local API default base URL: http://localhost:3001. Swagger UI: http://localhost:3001/api/docs.

Web apps (clients)

Variable Role
NEXT_PUBLIC_API_URL Base URL the dashboard / marketing apps call.
PUBLIC_DOCS_URL Where "Documentation" links point (production default https://docs.azscraper.com).
DOCS_SITE_PORT Local docs port (default 11111).

Documentation site

Runs on Python/MkDocs. Local default: http://localhost:11111. See the docs-site README.md for venv setup and mkdocs build --strict.