Skip to content

H.1 — Update README env vars (closes part of #223) #319

@v-patel

Description

@v-patel

H.1 — Update README env vars (closes part of #223)

What's wrong

README.md "Setup Environment Variables" section says:

- EMAIL_USER: Your Gmail address (for OTP delivery).
- EMAIL_PASS: Your Gmail App Password.

But server/utils/auth.ts and server/api/users/request-email-change.post.ts actually use EMAIL_SERVER_HOST, EMAIL_SERVER_PORT, EMAIL_SERVER_SECURE, EMAIL_SERVER_USER, EMAIL_SERVER_PASSWORD, and EMAIL_FROM. New devs follow the README and email is silently broken.

.env.example already has the correct variables.

How to fix

Replace the bullet list in README with:

- EMAIL_SERVER_HOST: SMTP host (e.g. smtp.gmail.com)
- EMAIL_SERVER_PORT: SMTP port (e.g. 465 for SSL, 587 for STARTTLS)
- EMAIL_SERVER_SECURE: 'true' if using SSL on the port above, 'false' otherwise
- EMAIL_SERVER_USER: SMTP username (typically your full email address)
- EMAIL_SERVER_PASSWORD: SMTP password — for Gmail use an App Password (https://support.google.com/accounts/answer/185833)
- EMAIL_FROM: The "From" address shown to recipients (e.g. "Reading Huddle <no-reply@example.com>")
- UPLOAD_STORAGE_PATH: Absolute path to where uploaded profile images are stored

Files

  • README.md "Setup Environment Variables" section

Severity

H.

Acceptance

  • README matches .env.example exactly.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions