From 6550785a8f5c47d90e802c5a4ab994a918340405 Mon Sep 17 00:00:00 2001 From: Sebuliba-Adrian Date: Sun, 10 May 2026 08:38:26 +0300 Subject: [PATCH] Remove hard-coded Gmail app password from setup docs --- .env.template | 8 +++++--- user_guide/01_getting_started.md | 8 ++++---- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/.env.template b/.env.template index d0f4342..e72a8cc 100644 --- a/.env.template +++ b/.env.template @@ -2,11 +2,13 @@ # Copy this file to .env and fill in your values: # cp .env.template .env -# Required: pick one +# Required: pick one OPENAI_API_KEY=your-openai-api-key-here OPEN_ROUTER_API_KEY=your-openrouter-api-key-here -# For reporting issues directly -GMAIL_APP_PASSWORD=sntt iusy rddg mtoi + +# Optional: Gmail App Password used only for the in-app "Report Issue" email flow +# Leave blank unless you explicitly want to enable issue-report email sending +GMAIL_APP_PASSWORD= # Security: VNC password (recommended if exposing to network) # Leave empty for no password (only safe for localhost access) diff --git a/user_guide/01_getting_started.md b/user_guide/01_getting_started.md index 8e8f221..f0ce247 100644 --- a/user_guide/01_getting_started.md +++ b/user_guide/01_getting_started.md @@ -10,15 +10,15 @@ ## 1. Create a `.env` file -Copy `.env.template` and paste the file into the project root (i.e. the cloned repo), rename this as `.env`. This files helps pass credentials into the container. The `GMAIL_APP_PASSWORD` (not an actual password, trust us) is for sending the error report directly to the developers. A minimal example of the `.env` file content: +Copy `.env.template` into the project root (i.e. the cloned repo) and rename it to `.env`. This file passes credentials into the container. `GMAIL_APP_PASSWORD` is optional and is only used if you want the in-app issue-report email flow. A minimal example of the `.env` file content: ```env -# Required: pick one +# Required: pick one OPENAI_API_KEY=your-openai-api-key-here OPEN_ROUTER_API_KEY=your-openrouter-api-key-here -# For reporting issues directly -GMAIL_APP_PASSWORD=sntt iusy rddg mtoi +# Optional: only needed for the in-app "Report Issue" email flow +GMAIL_APP_PASSWORD= ```