Docker Gateway Documentation
This directory contains documentation for the VXG Docker Uplink Gateway: a Django-based gateway that manages camera proxy tunnels and exposes a REST API and web UI.
Contents
Document | Description |
|---|---|
What the project does, main components, and how traffic flows. | |
Running the two-container stack with Docker Compose (primary deployment path). | |
Environment variables, secrets, and runtime settings. | |
REST API for authentication, cameras, gateway restart, and related operations. |
Quick start (Docker Compose)
From the repository, the Compose file lives at docker/docker-compose.yml. Typical flow:
Create a
.envfile next to that Compose file (see Gateway Configuration).Build or load the gateway and nginx images (see Gateway Deployment).
Start the stack:
docker compose -f docker/docker-compose.yml up -d(run from thedocker/directory soenv_fileresolves correctly).
The nginx service listens on port 80 and proxies to the app service (Django on port 8000 inside the network). Use http://<host>/ for the web UI and API unless you call the app container directly on port 8000 for debugging.