Skip to content

Commit 29c18ca

Browse files
committed
Revamp README.md: add detailed project description, installation steps, and security notes
1 parent 3b49dd0 commit 29c18ca

1 file changed

Lines changed: 52 additions & 2 deletions

File tree

README.md

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,53 @@
1-
# TelegramRobotsProxy
1+
# 🤖 Telegram Robots Proxy
22

3-
this Script retranslates queries to telegram bot API
3+
A lightweight PHP script that acts as a **proxy layer** between your client application and the official **Telegram Bot API**.
4+
It receives incoming requests, processes them, and forwards them to the Telegram servers — useful for adding custom logging, security layers, or bypassing access restrictions.
5+
6+
---
7+
8+
## ✨ Features
9+
- **Proxy functionality** for Telegram Bot API requests
10+
- Easy to deploy on any server with PHP & Apache
11+
- Supports clean URLs via `.htaccess` rewrite rules
12+
- BSD-3-Clause licensed for flexible use
13+
14+
---
15+
16+
## 📂 Project Structure
17+
├── index.php # Core proxy script
18+
├── .htaccess # URL rewrite and security headers
19+
├── LICENSE # BSD-3-Clause license
20+
└── README.md # Project documentation
21+
22+
23+
## 🚀 Getting Started
24+
25+
### 1. Requirements
26+
- PHP 7.4+
27+
- Apache with `mod_rewrite` enabled
28+
### 2. Installation
29+
Clone the repository into your web server's root:
30+
```bash
31+
git clone https://github.com/walid-khalafi/TelegramRobotsProxy.git
32+
cd TelegramRobotsProxy
33+
34+
35+
### 3. Configuration
36+
Edit config.php (create if not present) to set:
37+
- Your Telegram Bot Token
38+
- Telegram API endpoint
39+
- Optional: IP whitelist or API Key
40+
41+
42+
### 4. Deployment
43+
Upload the project to your hosting environment and ensure .htaccess is active.
44+
45+
46+
# 🛡 Security Recommendations
47+
- Restrict access by IP or authentication
48+
- Enable HTTPS on your server
49+
- Log requests and mask sensitive data
50+
51+
52+
#💡 Contributing
53+
Contributions are welcome! Fork the repository, make your changes in a feature branch, and submit a Pull Request.

0 commit comments

Comments
 (0)