Fix path
This commit is contained in:
@@ -131,30 +131,38 @@ This will create ProjectBeta with only alice and bob, regardless of the default
|
||||
|
||||
### What is QR Backup Data?
|
||||
|
||||
QR backup data is the GroupHelp settings backup payload generated by GroupHelp itself. It is used to copy GroupHelp settings, such as welcome-message configuration, from one group to another by pasting the QR payload as the body of a `.importbackup` message.
|
||||
QR backup data is the GroupHelp settings backup payload generated by GroupHelp itself. It is used to copy GroupHelp settings, such as welcome-message configuration, from one group to another by rendering the payload as a QR image and sending it with a `.importbackup` caption.
|
||||
|
||||
### Step 1: Generate or Obtain QR Code
|
||||
|
||||
Generate the QR backup from GroupHelp in the source group, then store the decoded/pasted payload here so it can be reused when importing those settings into another group.
|
||||
Generate the QR backup from GroupHelp in the source group. You can either store the decoded payload directly, or start the interactive importer and forward the original GroupHelp QR image message.
|
||||
|
||||
### Step 2: Set GroupHelp QR Backup Data
|
||||
|
||||
Store the GroupHelp QR backup data in the database:
|
||||
Store the GroupHelp QR backup payload directly:
|
||||
|
||||
```
|
||||
/set_qr_backup YOUR_QR_CODE_HERE
|
||||
/admin_set_qr YOUR_QR_PAYLOAD_HERE
|
||||
```
|
||||
|
||||
Example:
|
||||
```
|
||||
/set_qr_backup 0001a8ac0123456789abcdef0123456789abcdef01234567
|
||||
/admin_set_qr new_390530c569ec8902a6cbd8482d51d70d2857d4a0
|
||||
```
|
||||
|
||||
Or start the interactive QR importer:
|
||||
|
||||
```
|
||||
/admin_set_qr
|
||||
```
|
||||
|
||||
Then forward the original GroupHelp QR image message into the staff chat. The forwarded image message must have `.importbackup` as its caption/body. GroupFactory decodes the QR image and stores the decoded payload.
|
||||
|
||||
Response:
|
||||
```
|
||||
✅ QR backup data updated successfully!
|
||||
|
||||
Data: `0001a8ac0123456789abcdef0123456789abcdef01234567`
|
||||
Data: `new_390530c569ec8902a6cbd8482d51d70d2857d4a0`
|
||||
```
|
||||
|
||||
### Step 3: Retrieve GroupHelp QR Backup Data
|
||||
@@ -162,21 +170,21 @@ Data: `0001a8ac0123456789abcdef0123456789abcdef01234567`
|
||||
Retrieve the stored GroupHelp QR backup data anytime:
|
||||
|
||||
```
|
||||
/get_qr_backup
|
||||
/admin_get_qr
|
||||
```
|
||||
|
||||
Response:
|
||||
```
|
||||
📊 Current QR Backup Data:
|
||||
`0001a8ac0123456789abcdef0123456789abcdef01234567`
|
||||
`new_390530c569ec8902a6cbd8482d51d70d2857d4a0`
|
||||
```
|
||||
|
||||
### Step 4: Use QR Backup with GroupHelp
|
||||
|
||||
Once you have the QR backup data stored, you can:
|
||||
1. Retrieve it with `/get_qr_backup`
|
||||
2. Paste it into the target group as the message body for `.importbackup`
|
||||
3. Let GroupHelp import the backed-up settings into that group
|
||||
1. Retrieve it with `/admin_get_qr`
|
||||
2. Let GroupFactory render it as a QR image during `!newgrp`
|
||||
3. Let GroupHelp import the backed-up settings from the `.importbackup` image message
|
||||
|
||||
---
|
||||
|
||||
@@ -241,10 +249,10 @@ The configuration data is stored in MongoDB with the following structure:
|
||||
|
||||
```bash
|
||||
# Retrieve the stored GroupHelp QR payload:
|
||||
/get_qr_backup
|
||||
/admin_get_qr
|
||||
|
||||
# In the target group, paste the payload with:
|
||||
.importbackup <paste_qr_code_here>
|
||||
# During !newgrp, GroupFactory sends the payload as a QR image with:
|
||||
.importbackup
|
||||
```
|
||||
|
||||
---
|
||||
@@ -265,8 +273,8 @@ The configuration data is stored in MongoDB with the following structure:
|
||||
|
||||
### Issue: GroupHelp QR backup data appears empty
|
||||
**Solution:**
|
||||
1. Check if data was stored: `/get_qr_backup`
|
||||
2. Re-set the data: `/set_qr_backup <your_qr_code>`
|
||||
1. Check if data was stored: `/admin_get_qr`
|
||||
2. Re-set the data: `/admin_set_qr <your_qr_payload>` or use `/admin_set_qr` and forward the `.importbackup` QR image
|
||||
|
||||
---
|
||||
|
||||
@@ -309,8 +317,9 @@ FACTORY_BOT_USERNAME=your_bot_username
|
||||
- `/set_default_users <id1> <id2> ...` - Set default users (replace)
|
||||
- `/add_default_users <id1> <id2> ...` - Add users to default list
|
||||
- `/remove_default_users <id1> <id2> ...` - Remove users from default list
|
||||
- `/get_qr_backup` - View GroupHelp QR backup data
|
||||
- `/set_qr_backup <data>` - Set GroupHelp QR backup data
|
||||
- `/admin_get_qr` - View GroupHelp QR backup data
|
||||
- `/admin_set_qr <qr_payload>` - Set GroupHelp QR backup data directly
|
||||
- `/admin_set_qr` - Decode a forwarded `.importbackup` QR image
|
||||
- `/config_help` - Show configuration command help
|
||||
- `/help` - Show all available commands
|
||||
|
||||
@@ -362,7 +371,7 @@ db.ghconfig.find({key: 'qr_backup_data'})
|
||||
## Operational Notes
|
||||
|
||||
1. QR backup data is a GroupHelp configuration payload, not a Telegram or Telethon session.
|
||||
2. Use `.importbackup` in the target group to import the stored GroupHelp settings.
|
||||
2. During `!newgrp`, GroupFactory sends `.importbackup` with the stored GroupHelp settings as a QR image.
|
||||
3. Limit configuration commands to trusted chats so group settings are changed intentionally.
|
||||
4. Monitor command usage if multiple operators manage the same groups.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user