Skip to content

Docs: add the missing mailer keys and login.default_email_domain to the Configuration page - #160

Open
Robertpaschal wants to merge 1 commit into
OpsiMate:mainfrom
Robertpaschal:docs/mailer-keys-1314
Open

Robertpaschal wants to merge 1 commit into
OpsiMate:mainfrom
Robertpaschal:docs/mailer-keys-1314

Conversation

@Robertpaschal

@Robertpaschal Robertpaschal commented Oct 26, 2026 •

Copy link
Copy Markdown

The Configuration page says it covers every key the server reads, but some mailer keys were missing: replyTo, tls.rejectUnauthorized, and the welcome email's subject and content. So was login.default_email_domain and its LOGIN_DEFAULT_EMAIL_DOMAIN variable.

This adds them to the example mailer block (commented out) with a short table of defaults and effects. It also says plainly that rejectUnauthorized: false turns off certificate checks and is only for self-signed SMTP servers, notes that only the first admin gets the welcome email, and says these mailer keys have no env var. The login key goes in the key reference table and the variable in the "always apply" table, with a note that the file value wins.

I checked each key against apps/server/src/config/config.ts, mail-client.ts, utils/mailTemplate.ts and user.bl.ts on main, and npm run build passes with no broken links. Screenshot attached.

Closes OpsiMate/OpsiMate#1314

Configuration page, Email (SMTP) section

Summary by CodeRabbit

  • Documentation
    • Updated the configuration guide with options for setting a default login email domain, including how file and environment-variable values interact.
    • Added SMTP configuration examples for reply-to addresses, welcome-email templates, and TLS certificate verification.
    • Clarified that these SMTP options are configured in YAML and that the welcome email is sent once to the first administrator.

@mintlify

mintlify Bot commented Oct 26, 2026

Copy link
Copy Markdown

Preview approval required

This pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit 349a5a7.

Approve preview

@vercel

vercel Bot commented Oct 26, 2026

Copy link
Copy Markdown

@Robertpaschal is attempting to deploy a commit to the idan lodzki's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions

Copy link
Copy Markdown

Thanks for your contribution! Join our Slack: https://join.slack.com/t/opsimate/shared_invite/zt-39bq3x6et-NrVCZzH7xuBGIXmOjJM7gA Please make sure to include an image with your PR — it really helps us review and understand the changes better. Only in rare cases will we accept a PR without one. Also, take a moment to review your code to ensure it’s clear, readable, and easy to follow. PRs from contributors who haven’t joined our Slack community or starred the repository won’t be reviewed — we’d love to see you join and be part of the project!

@coderabbitai

coderabbitai Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 6fa12a9 and 349a5a7.

Files selected for processing: 1
  • opsimate-docs/docs/getting-started/configuration.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The configuration guide now documents the login default email domain key and environment variable, plus SMTP Reply-To, welcome-template, and TLS settings. It also describes file-over-environment precedence, YAML-only settings, and when the welcome email is sent.

Changes: Configuration guide

Layer / File(s) Summary
Document login and SMTP settings
opsimate-docs/docs/getting-started/configuration.md
The guide adds the login domain key and environment variable, and documents optional SMTP settings, their YAML-only availability, and first-admin welcome-email behavior.

Assessment against linked issues

Objective Addressed Explanation
Document replyTo, TLS certificate verification, welcome-template settings and behavior, and login default email domain configuration [#1314] ✅

Possibly related PRs

Suggested reviewers: sridharkalaibala

Priority: Low

Change: Other · Severity of issue fixed: Low

Merge Risk: Minimal · up to 349a5

No actionable issue was verified in this documentation-only change.

Finishing Touches: 💡 1
🛠️ Fix failing CI checks: 💡
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Configuration page: add the missing mailer keys (replyTo, tls, welcome template) and login.default_email_domain

1 participant