Skip to content

updated docs for Telegram bot #39528

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 4 commits into
base: next
Choose a base branch
from
Open

updated docs for Telegram bot #39528

wants to merge 4 commits into from

Conversation

hanwg
Copy link
Contributor

@hanwg hanwg commented Jun 13, 2025 •
edited by c0ffeeca7
Loading

Proposed change

Improve documentation for new features:

  • Updated prerequisites to include allowlist_external_dirs requirement for local files
  • Added note in webhooks section to inform that self-signed certificates are not supported
  • Added plain_text missing from the parse mode options

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Enhanced Telegram bot integration guide with additional configuration details and clarifications.
    • Added instructions for allowing the bot to access local files.
    • Clarified HTTPS certificate requirements for Webhooks.
    • Expanded reverse proxy configuration examples.
    • Updated trusted networks default IP range information.
    • Included plain_text as a valid parse mode option.

@home-assistant home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch next This PR goes into the next branch labels Jun 13, 2025
@home-assistant
Copy link

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

@netlify Netlify
Copy link

netlify bot commented Jun 13, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 85b3aa1
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/684c1aa42d4c52000856d2e8
😎 Deploy Preview https://deploy-preview-39528--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@hanwg hanwg marked this pull request as ready for review June 13, 2025 12:36
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 13, 2025

📝 Walkthrough

Walkthrough

The Telegram bot integration documentation was updated to include more detailed configuration instructions. Additions cover file access permissions, HTTPS certificate requirements, expanded reverse proxy examples, clarification of trusted network defaults, and the inclusion of plain_text as a valid parse mode option.

Changes

File Change Summary
source/_integrations/telegram_bot.markdown Enhanced documentation with new sections on file access, HTTPS requirements, expanded reverse proxy example, trusted networks, and parse modes.

Sequence Diagram(s)

No sequence diagram generated as the changes are documentation-only and do not affect control flow or functionality.

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
🪧 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 or @coderabbitai title 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.

coderabbitai[bot]
coderabbitai bot reviewed Jun 13, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
source/_integrations/telegram_bot.markdown (1)

56-59: Consider using a stronger admonition for certificate requirements
Recommending {% warning %} instead of {% note %} to emphasize that self-signed certificates are not supported and public CAs are required.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between bc3bcc0 and 85b3aa1.

📒 Files selected for processing (1)
  • source/_integrations/telegram_bot.markdown (4 hunks)
🔇 Additional comments (4)
source/_integrations/telegram_bot.markdown (4)

42-52: New section for file access permissions looks good
Clarifies the need to add local directories to allowlist_external_dirs for sending files. The example snippet is clear and correctly formatted.

75-83: Expanded reverse proxy HTTP integration example is clear
The added use_x_forwarded_for and trusted_proxies settings with a sample IP range accurately illustrate the required configuration.

113-115: Trusted networks default values updated correctly
Specifying 149.154.160.0/20, 91.108.4.0/22 as the default ACL aligns with Telegram’s official IP ranges.

122-124: plain_text parse mode inclusion is accurate
Adding plain_text alongside markdown, markdownv2, and html matches the Telegram Bot API.

@hanwg hanwg removed their assignment Jun 22, 2025
c0ffeeca7
c0ffeeca7 approved these changes Jun 26, 2025
View reviewed changes
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @hanwg 👍

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo and removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Jun 26, 2025
@c0ffeeca7 c0ffeeca7 added awaits-parent Awaits the merge of an parent PR and removed in-progress This PR/Issue is currently being worked on labels Jun 26, 2025
@c0ffeeca7
Copy link
Contributor

Thank you for contributing, @hanwg 💪

For future PRs, please fill out the PR template and provide the link to the parent PR.

image

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

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@c0ffeeca7 c0ffeeca7 c0ffeeca7 approved these changes

Assignees
No one assigned
Labels
awaits-parent Awaits the merge of an parent PR has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hanwg @c0ffeeca7