Files
docker-compose-repo/librespeed/.env.example
T
2026-09-23 15:11:31 +02:00

51 lines
2.1 KiB
Bash

# Copy to .env and adjust. .env is git-ignored; this file is not.
#
# NOTE: compose.yaml currently sets these values literally in its
# `environment:` block, so nothing here is read yet. Switch a line to
# ${VAR} in compose.yaml to start using it -- worth doing for the two
# marked SECRET below, which should never sit in a committed file.
# ─── Basics ─────────────────────────────────────────────────────────
#TITLE=LibreSpeed
#TAGLINE=
# Port on the host; the container always listens on WEBPORT (8080).
#PORT=3011
# ─── Telemetry: off by default ──────────────────────────────────────
# Turn this on and results are stored -- which needs a database AND a
# volume, neither of which compose.yaml has today. See the README.
#TELEMETRY=false
# SECRET. Protects the stats page at /results/stats.php. Required once
# telemetry is on, or anyone can read every result.
#PASSWORD=
# Shown in the privacy policy as the contact for deletion requests.
# Required for a production install with telemetry. NOTE: the old EMAIL
# variable is deprecated -- this is the current name.
#GDPR_EMAIL=you@example.com
# Telemetry logs client IPs unless you turn this on.
#REDACT_IP_ADDRESSES=false
#ENABLE_ID_OBFUSCATION=false
# 2-byte hex, e.g. 0x1234abcd. Random if unset -- which means IDs change
# every restart.
#OBFUSCATION_SALT=
# ─── Database (only when TELEMETRY=true) ────────────────────────────
# sqlite needs /database mounted or results vanish on recreate.
#DB_TYPE=sqlite
#DB_NAME=
#DB_HOSTNAME=
#DB_PORT=
#DB_USERNAME=
#DB_PASSWORD=
# ─── ISP name and distance ──────────────────────────────────────────
# SECRET. From ipinfo.io. Without it there is no ISP name, and DISTANCE
# does nothing.
#IPINFO_APIKEY=
#DISABLE_IPINFO=false
# km, mi, or empty to hide it. Needs IPINFO_APIKEY.
#DISTANCE=km