.env.example

# .env.example — example environment variables for SOARCA-GUI
# Copy this file to `.env.development` for local dev or to `.env` for Docker Compose
# Notes:
#  - Vite exposes ONLY variables prefixed with `VITE_` to the client (import.meta.env).
#  - Client-visible `VITE_` values are embedded at *build time* (rebuild to change).
#  - Docker Compose reads the project `.env` for substitution and container envs.
#  - We also follow a consumer based prefix convention for clarity, so variables used by nginx start with NGINX_, those used by the dev server start with VITE_ etc.

########## Development (Vite) ##########
# Used by `npm run dev` / Vite dev server. Client-facing variables MUST start with VITE_.
# copy these lines into `.env.development` or `.env` (see Vite docs at https://vite.dev/guide/env-and-mode) and adjust as needed for local development
VITE_BACKEND_URL=http://localhost:8080 # backend API URL used by the frontend (dev server proxy target)
VITE_SERVER_PORT=5173 # dev server port
VITE_ENABLE_HTTPS=false # set true to serve the GUI over HTTPS
VITE_HTTPS_CERT_FILE= # required when VITE_ENABLE_HTTPS=true
VITE_HTTPS_KEY_FILE= # required when VITE_ENABLE_HTTPS=true
VITE_VERIFY_SSL=false # set true to verify the backend TLS certificate
VITE_USE_POLLING=false # set true when the filesystem does not emit file events reliably

########## Docker Compose (dev) ##########
# Values used by `docker-compose.dev.yml`. Compose will substitute ${VAR} from the
# project `.env` or the shell environment when you run `docker compose`.
VITE_APP_VERSION=development
VITE_BACKEND_URL=http://host.docker.internal:8080 # backend API URL used by the frontend inside the container (resolved via Compose host mapping)
VITE_SERVER_PORT=5173 # dev server port inside the container
VITE_ENABLE_HTTPS=false # set true to serve the GUI over HTTPS
VITE_HTTPS_CERT_FILE=/app/certs/server.crt # certificate mounted from ./certs
VITE_HTTPS_KEY_FILE=/app/certs/server.key # certificate key mounted from ./certs
VITE_VERIFY_SSL=false # set true to verify the backend TLS certificate
DOCKER_HOST_PORT=5173 # port on the host machine mapped to the container's VITE_SERVER_PORT (for browser access)

########## Production (nginx) ##########
# Values used at container runtime by nginx to serve HTTPS and proxy /api/.
SOARCA_GUI_VERSION=latest # Docker Hub image tag
SOARCA_CERTS_VOLUME=soarca_certs_data_container # external volume created by SOARCA
NGINX_BACKEND_URL=https://host.docker.internal:8080/ # backend API URL used by nginx inside the container
NGINX_SERVER_PORT=8081 # port nginx listens on inside the container
NGINX_CERT_FILE=/app/certs/server.crt # TLS certificate mounted from SOARCA_CERTS_VOLUME
NGINX_CERT_KEY_FILE=/app/certs/server.key # TLS certificate key mounted from SOARCA_CERTS_VOLUME
NGINX_PROXY_SSL_VERIFY=off # set to on when the backend certificate is trusted
DOCKER_HOST_PORT=8081 # port on the host machine mapped to the container's NGINX_SERVER_PORT (for browser access)