GMSurroundVision/.env.example at main · absginc/GMSurroundVision · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# GM SurroundVision — configuration
#
# Copy this file to .env and edit. Node 22 reads env files natively, so there
# is nothing to install:
#
#     cp .env.example .env
#     node --env-file=.env server.js
#
# Every line below is the built-in default: running plain `node server.js`
# with no .env behaves exactly as shown here.
#
# Paths may be absolute, relative to the project root (the folder holding
# server.js), or start with ~ for your home directory.


# ---------------------------------------------------------------------------
# PORT — port for the local web UI.
# The server binds 127.0.0.1 only (never exposed to the network). If the port
# is taken it climbs one at a time up to PORT+10 (4171 -> 4181 by default).
# ---------------------------------------------------------------------------
PORT=4171


# ---------------------------------------------------------------------------
# RECORDINGS_DIR — folder of SurroundVision clips, named
# {FRONT|LEFT|REAR|RIGHT}_{YYYY}_{MM}_{DD}_T_{HH}_{MM}_{SS}.mp4
# Read-only: the app never writes here. If the folder is missing the server
# still starts and simply shows no trips.
# ---------------------------------------------------------------------------
RECORDINGS_DIR=./Recordings/SurroundVisionRecorder


# ---------------------------------------------------------------------------
# EXPORTS_DIR — where finished export mp4s are written. Created at startup if
# it does not exist.
# ---------------------------------------------------------------------------
EXPORTS_DIR=./Exports


# ---------------------------------------------------------------------------
# CACHE_DIR — where the server keeps its working data: thumbnails (thumbs/),
# export job temp files (jobs/) and the ffprobe duration cache (probe.json).
# Created at startup if it does not exist. Safe to delete when the server is
# stopped; everything in it is regenerated on demand.
# ---------------------------------------------------------------------------
CACHE_DIR=./.cache


# ---------------------------------------------------------------------------
# FFMPEG_PATH / FFPROBE_PATH — leave unset to auto-detect at startup:
# PATH first, then /opt/homebrew/bin, /usr/local/bin, /usr/bin, /snap/bin
# (plus C:\ffmpeg\bin, %ProgramFiles%\ffmpeg\bin and the winget links folder on
# Windows). Set them if ffmpeg lives somewhere unusual, or to pin a specific
# build. The chosen binary must run `-version` or the server refuses to start.
#
# Install ffmpeg (it provides both binaries):
#     macOS          brew install ffmpeg
#     Debian/Ubuntu  sudo apt install ffmpeg
#     Windows        winget install Gyan.FFmpeg
# ---------------------------------------------------------------------------
#FFMPEG_PATH=/opt/homebrew/bin/ffmpeg
#FFPROBE_PATH=/opt/homebrew/bin/ffprobe


# ---------------------------------------------------------------------------
# EXPORT_PREFIX — leading token on every exported filename, e.g.
# SV_2026-07-29_07-53-06_QUAD_0-10-00_30s.mp4
# Set it to your own callsign or fleet name to brand your output.
# ---------------------------------------------------------------------------
EXPORT_PREFIX=SV