Skip to content

Remove hard-coded Gmail app password from setup docs #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Sebuliba-Adrian wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Remove hard-coded Gmail app password from setup docs #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions .env.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 4 additions & 4 deletions user_guide/01_getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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=

```

Expand Down