Skip to content

Commit f45ec14

Browse files
author
Your Name
committed
README edit
1 parent 9194430 commit f45ec14

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Whatseerr
22

3-
WhatsApp bot for Seerr ([Jellyseerr](https://github.com/Fallenbagel/jellyseerr) / [Overseerr](https://github.com/sct/overseerr)) that allows users to search and request movies/TV shows via WhatsApp messages.
3+
WhatsApp bot for Seerr that allows users to search and request movies/TV shows via WhatsApp messages.
44

55
## Features
66

@@ -16,11 +16,15 @@ WhatsApp bot for Seerr ([Jellyseerr](https://github.com/Fallenbagel/jellyseerr)
1616
### Prerequisites
1717

1818
- [WAHA](https://github.com/devlikeapro/waha) (WhatsApp HTTP API) running and configured
19-
- Seerr (Jellyseerr or Overseerr) instance
19+
- Seerr instance
2020
- Docker installed
2121

2222
### 1. Pull the Image and Run
2323

24+
```bash
25+
docker pull ghcr.io/sufxgit/whatseerr:latest
26+
```
27+
2428
#### Environment Variables
2529

2630
| Variable | Description | Required | Default |
@@ -45,17 +49,26 @@ services:
4549
4650
**Configuration Notes:**
4751
- On first run, a `config.example.json` will be created in your config directory
48-
- Copy it to `config.json` and update with your settings:
52+
- Rename it to `config.json` and update with your settings:
4953
- `host`: The hostname/IP where Seerr, WAHA, and the bot can reach each other
5054
- `jellyseerr.apiKey`: Get from Seerr → Settings → General
5155
- `waha.apiKey`: Your WAHA API key
5256
- `userIdMappings`: Map WhatsApp phone numbers (without @c.us) to Seerr user IDs
57+
```json
58+
"1234567890": {
59+
"userId": 1,
60+
"username": ""
61+
}
62+
```
63+
- `"1234567890"`: WhatsApp phone number including country code (without @c.us suffix)
64+
- `userId`: The user ID from your Seerr instance - each user has their own unique ID (found in Seerr → Users)
65+
- `username`: Optional custom display name (leave empty to use Seerr username)
5366

5467
**Unraid:**
5568
- Repository: `ghcr.io/sufxgit/whatseerr:latest`
5669
- Port: `3006:3006` (TCP)
5770
- Volume: `/mnt/user/appdata/whatseerr/config` → `/config` (Read/Write)
58-
- Environment: `TZ=Your/Timezone`
71+
- Variable: `TZ=Your/Timezone`
5972

6073
### 2. Configure WAHA Webhook
6174

@@ -65,8 +78,9 @@ http://YOUR_HOST_IP:3006/requests
6578
```
6679

6780
Enable these events:
81+
- `session.status`
6882
- `message`
69-
- `message.any`
83+
- `message.reactions`
7084

7185
### 3. Configure Seerr Webhook (Optional)
7286

0 commit comments

Comments
 (0)