docs: add environment variables reference guide#3539
Closed
Smolcup wants to merge 1 commit intobluewave-labs:developfrom
Closed
docs: add environment variables reference guide#3539Smolcup wants to merge 1 commit intobluewave-labs:developfrom
Smolcup wants to merge 1 commit intobluewave-labs:developfrom
Conversation
Smolcup
requested review from
Br0wnHammer,
Owaiseimdad,
ajhollid and
karenvicent
as code owners
ajhollid
requested changes
Apr 17, 2026
Collaborator
ajhollid
left a comment
ajhollid
left a comment
There was a problem hiding this comment.
These docs are inaccurate, please review the source code
Comment on lines
+12
to
+13
| | `REDIS_HOST` | Redis host | `localhost` | | ||
| | `REDIS_PORT` | Redis port | `6379` | |
| | `REDIS_HOST` | Redis host | `localhost` | | ||
| | `REDIS_PORT` | Redis port | `6379` | | ||
| | `TOKEN_TTL` | JWT token expiry | `99d` | | ||
| | `REFRESH_TOKEN_TTL` | Refresh token expiry | `7d` | |
Collaborator
There was a problem hiding this comment.
RERFRESH_TOKEN_TTL no longer used
Comment on lines
+25
to
+31
| | Variable | Description | | ||
| |----------|-------------| | ||
| | `SYSTEM_EMAIL_ADDRESS` | From address for emails | | ||
| | `SMTP_HOST` | SMTP server host | | ||
| | `SMTP_PORT` | SMTP server port | | ||
| | `SMTP_USER` | SMTP username | | ||
| | `SMTP_PASSWORD` | SMTP password | |
Comment on lines
+33
to
+38
| ## Optional Features | ||
|
|
||
| | Variable | Description | | ||
| |----------|-------------| | ||
| | `PAGESPEED_API_KEY` | Google PageSpeed API key | | ||
| | `DOCKER_HOST` | Docker daemon socket path | |
Contributor
Author
|
Thank you for your feedback, I'll get back to working on it! |
Smolcup
force-pushed
the
docs/add-environment-variables-guide
branch
from
d555f1f to
6b43a41
Compare
Contributor
Author
|
I have updated the file accordingly, thank you for your work! |
ajhollid
requested changes
Apr 20, 2026
Collaborator
ajhollid
left a comment
ajhollid
left a comment
There was a problem hiding this comment.
There are some missing vars and some other minor changes to make, please see my comments in the code review.
Thanks!
|
|
||
| | Variable | Description | Default | | ||
| |----------|-------------|---------| | ||
| | `NODE_ENV` | Application environment | `development` | |
| | `NODE_ENV` | Application environment | `development` | | ||
| | `LOG_LEVEL` | Logging level | `debug` | | ||
| | `TOKEN_TTL` | JWT token expiry time | `99d` | | ||
| | `CLIENT_HOST` | Frontend URL | `http://localhost:5173` | |
|
|
||
| ## Notes | ||
|
|
||
| - The server reads these variables from `server/.env` |
Collaborator
There was a problem hiding this comment.
All vars are read from server/.env, this line seems to indicate that only JWT_SECRET and TOKEN_TTL are read from .env. This line can just be removed safely.
| # Environment Variables | ||
|
|
||
| This document describes the environment variables used by Checkmate server. | ||
|
|
Collaborator
There was a problem hiding this comment.
Missing the required client env vars
VITE_APP_API_BASE_URL
VITE_APP_CLIENT_HOST
Collaborator
|
Closing as inactive |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Describe your changes
Adds comprehensive documentation for all environment variables used by Checkmate server and client.
Write your issue number after "Fixes "
No issue was fixed, this is a documentation contribution.
Please ensure all items are checked off before requesting a review. "Checked off" means you need to add an "x" character between brackets so they turn into checkmarks.
<div>Add</div>, use):npm run formatin server and client directories, which automatically formats your code.