Files
typewriter/firmware/.env.example
Julien Calixte 63ffd7e37a feat(firmware): bake and document git push env vars
build.rs embeds TW_REMOTE_URL / TW_GH_USER / TW_PAT / TW_AUTHOR_* via env!()
so only the git_push binary carries them (the editor references none), and
.env.example documents them. NOTE: TW_PAT lands in the git_push flash image
-- a bench-only shortcut (ADR-005); a product must not embed the PAT.
2026-07-06 00:18:22 +02:00

26 lines
1.1 KiB
Plaintext

# Build-time config for the network spikes (6/7). Copy to `.env` and fill in.
# `.env` is gitignored; `just` loads it automatically (dotenv-load) so the
# values reach build.rs, which emits them as compile-time env for the binary.
#
# cp .env.example .env # then edit
# just flash-wifi # Spike 6 — Wi-Fi + TLS
#
# Only the editor build (`just flash`) needs none of these.
# Home Wi-Fi (2.4 GHz — the ESP32-S3 has no 5 GHz radio).
TW_WIFI_SSID=your-ssid
TW_WIFI_PASS=your-password
# Note: the spike assumes WPA2-Personal. Open network → leave TW_WIFI_PASS empty.
# A WPA3-only AP needs AuthMethod::WPA3Personal in src/bin/wifi_tls.rs.
# Spike 7 — on-device git push (`just flash-git-push`, src/bin/git_push.rs).
# HTTPS + PAT auth (ADR-005); baked into the git_push image at build time and
# never logged. Point TW_REMOTE_URL at a THROWAWAY test repo — the spike pushes
# a fresh `device/<unix>` branch on every boot.
TW_REMOTE_URL=https://github.com/you/typoena-test.git
TW_GH_USER=your-github-username
TW_PAT=ghp_xxxxxxxxxxxxxxxxxxxx
# Commit author (message is a timestamp).
TW_AUTHOR_NAME=Typoena
TW_AUTHOR_EMAIL=typoena@example.com