docs: warn about escaping $ in SMTP_PASSWORD#2406
Closed
Teraformerrr wants to merge 1 commit intobaptisteArno:mainfrom
Closed
docs: warn about escaping $ in SMTP_PASSWORD#2406Teraformerrr wants to merge 1 commit intobaptisteArno:mainfrom
Teraformerrr wants to merge 1 commit intobaptisteArno:mainfrom
Conversation
The dotenv CLI interprets $ as shell variable interpolation, which silently corrupts SMTP passwords containing $. Added warnings to .env.example, .env.dev.example, and configuration docs.
|
@Teraformerrr is attempting to deploy a commit to the Typebot Team on Vercel. A member of the Team first needs to authorize it. |
Owner
|
I appreciate the PR but I think it is out of scope to be honest, Typebot should not document how dotenv cli .env parsing works. |
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.
What does this PR do?
Adds documentation warning about the
$character inSMTP_PASSWORDvalues.Problem
When
SMTP_PASSWORDcontains a$character, the dotenv CLI (used to start the app) passes values through shell interpolation. The$is treated as the start of a variable name, silently corrupting the password and causing535 Incorrect authentication dataerrors.For example,
abc$defghijsilently becomesabcat runtime.Changes
.env.example: Added SMTP configuration block with warning about$escaping.env.dev.example: Same SMTP block and warning addedapps/docs/self-hosting/configuration.mdx: Added a<Note>with correct/incorrect examples after the SMTP tableRelated Issue
Fixes the issue reported by @alehostert regarding SMTP_PASSWORD dollar sign escaping.