Skip to content

Update and Clarify .env.example Documentation for Inbound Postmark & Sendgrid Config #8234

Closed
@willkramer

Description

Is your feature or enhancement related to a problem? Please describe.

While configuring Chatwoot with the .env.example file, I noticed some instructions that could be unclear for those unfamiliar with the setup process. In particular, the sections detailing the inbound webhook URLs could more clearly specify which parts require user input and an example of the inbound webhook URL.

Additionally, we should add a Postmark instruction to "Include raw email content in JSON payload".

Describe the solution you'd like

I'd like to propose the following enhancements to the .env.example file:

  1. Modify instructions related to inbound email settings to be more intuitive.
  2. Use a clear format to indicate parts of URLs that need user input, ensuring users can easily identify and replace them.
  3. Add clarifications for settings like the "Include raw email content in JSON payload" to make it unmistakably clear for users during setup.

Describe alternatives you've considered

An alternative would be to add a separate documentation guide on setting up the .env file from the .env.example, but integrating these clarifications directly within the .env.example file provides immediate guidance to developers during setup without the need to refer to external documents.

Additional context

During my personal setup experience, I felt that these changes could significantly improve the onboarding process for other developers in the future.

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions