Edited documentation and removed SMTP configs from env

[KesterTan]

Description

This resolves #2177. With the recent change, SMTP configs are no longer taken from the env file but are configured using the UI and saved in the config. For more information see #2168. This PR removes the following from the env file and docker compose file.

HOST_PROTOCOL
HOST_DOMAIN
SMTP_SETTINGS_ADDRESS
SMTP_SETTINGS_PORT
SMTP_SETTINGS_ENABLE_STARTTLS_AUTO
SMTP_SETTINGS_AUTHENTICATION
SMTP_SETTINGS_USER_NAME
SMTP_SETTINGS_PASSWORD
SMTP_SETTINGS_DOMAIN

How Has This Been Tested?

• Test docker installation of Autolab with these changes, check that you can save configuration and when you send an email, it works and its received which shows that SMTP configuration is a success.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• I have run rubocop and erblint for style check. If you haven't, run overcommit --install && overcommit --sign to use pre-commit hook for linting
• My change requires a change to the documentation, which is located at Autolab Docs
• I have updated the documentation accordingly, included in this PR

[coderabbitai]

Walkthrough

Walkthrough

The recent changes involve the removal of several SMTP-related configuration settings from the .env.template file. These settings included various parameters such as address, port, authentication details, and domain information. Additionally, the HOST_PROTOCOL and HOST_DOMAIN variables were also deleted. The modifications indicate a potential shift in the management of email configurations, with the remaining settings focusing solely on MySQL configurations.

Changes

File	Change Summary
.env.template	Removed multiple SMTP settings: SMTP_SETTINGS_ADDRESS, SMTP_SETTINGS_PORT, SMTP_SETTINGS_ENABLE_STARTTLS_AUTO, SMTP_SETTINGS_AUTHENTICATION, SMTP_SETTINGS_USER_NAME, SMTP_SETTINGS_PASSWORD, SMTP_SETTINGS_DOMAIN, SMTP_DEFAULT_FROM, HOST_PROTOCOL, and HOST_DOMAIN.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f95a2e6 and d3fcf13.

Files ignored due to path filters (1)

• docker-compose.yml is excluded by !**/*.yml

Files selected for processing (1)

• .env.template (1 hunks)

Files skipped from review due to trivial changes (1)

• .env.template

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

Tip

Early access features: enabled

We are currently testing the following features in early access:

• Anthropic claude-3-5-sonnet for code reviews: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. Note: Our default code review model was also updated late last week. Please compare the quality of the reviews between the two models by toggling the early access feature.

Note:

• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
• Please join our Discord Community to provide feedback and report issues on the discussion post.

[20wildmanj]

verified that smtp setup still works and that proper envs are being removed. LGTM. Will want to verify one more time once both changes are merged in