-
-
Notifications
You must be signed in to change notification settings - Fork 106
Add Telegram backend documentation #357
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.
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
Conversation
Co-authored-by: nijel <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds documentation for the Telegram authentication backend to the social-python-social-auth library. The documentation describes how to set up Telegram's widget-based authentication using a bot token.
- New documentation file created for Telegram backend setup
- Index updated to include Telegram in the alphabetical list of supported backends
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/backends/telegram.rst | Comprehensive setup guide for Telegram authentication backend including bot creation, configuration settings, widget integration, and security details |
| docs/backends/index.rst | Added telegram entry to the alphabetical list of social backends |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| - The Telegram Login Widget can be added using the following HTML:: | ||
|
|
||
| <script async src="https://telegram.org/js/telegram-widget.js?22" |
Copilot
AI
Nov 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The ?22 query parameter in the Telegram widget script URL is unclear. If this is a version number required by Telegram's API, it should be documented or explained. If it's not necessary, it should be removed. Please verify this is the correct and current script URL from Telegram's official documentation.
| <script async src="https://telegram.org/js/telegram-widget.js?22" | |
| <script async src="https://telegram.org/js/telegram-widget.js" |
| data-telegram-login="YOUR_BOT_USERNAME" | ||
| data-size="large" | ||
| data-auth-url="http://example.com/complete/telegram/" | ||
| data-request-access="write"></script> |
Copilot
AI
Nov 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The data-request-access="write" attribute should be explained. It's unclear what "write" access means in the context of Telegram authentication and whether this is required, optional, or what other values are acceptable. Consider adding a brief explanation or link to Telegram's documentation about this parameter.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
The Telegram authentication backend exists in social-core but lacked documentation in social-docs.
Changes
Created
docs/backends/telegram.rstwith configuration instructions:AUTHENTICATION_BACKENDSUpdated
docs/backends/index.rstto include telegram in alphabetical orderUsage Example
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
docs.python.org/usr/bin/python3 /home/REDACTED/.local/bin/sphinx-build -b html -d _build/doctrees . _build/html(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.