Skip to content

Commit 3421d9c

Browse files
committed
docs: add github container registry support and update documentation
- Added GitHub Container Registry image link in download section - Updated docker run and docker-compose examples to include both Docker Hub and GitHub Container Registry - Fixed group invite link endpoint in API documentation - Added env file examples for both container registries
1 parent ce8cd69 commit 3421d9c

File tree

1 file changed

+59
-3
lines changed

1 file changed

+59
-3
lines changed

readme.md

Lines changed: 59 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ ___
2222
Download:
2323

2424
- [Release](https://github.com/aldinokemal/go-whatsapp-web-multidevice/releases/latest)
25-
- [Docker Image](https://hub.docker.com/r/aldinokemal2104/go-whatsapp-web-multidevice/tags)
25+
- [Docker Hub](https://hub.docker.com/r/aldinokemal2104/go-whatsapp-web-multidevice/tags)
26+
- [GitHub Container Registry](https://github.com/aldinokemal/go-whatsapp-web-multidevice/pkgs/container/go-whatsapp-web-multidevice)
2627

2728
## Support n8n package (n8n.io)
2829

@@ -225,14 +226,22 @@ For AI tools that support MCP with SSE (like Cursor), add this configuration:
225226

226227
### Production Mode REST (docker)
227228

229+
Using Docker Hub:
228230
```bash
229231
docker run --detach --publish=3000:3000 --name=whatsapp --restart=always --volume=$(docker volume create --name=whatsapp):/app/storages aldinokemal2104/go-whatsapp-web-multidevice rest --autoreply="Dont't reply this message please"
230232
```
231233

234+
Using GitHub Container Registry:
235+
```bash
236+
docker run --detach --publish=3000:3000 --name=whatsapp --restart=always --volume=$(docker volume create --name=whatsapp):/app/storages ghcr.io/aldinokemal/go-whatsapp-web-multidevice rest --autoreply="Dont't reply this message please"
237+
```
238+
232239
### Production Mode REST (docker compose)
233240

234241
create `docker-compose.yml` file with the following configuration:
235242

243+
Using Docker Hub:
244+
236245
```yml
237246
services:
238247
whatsapp:
@@ -255,7 +264,31 @@ volumes:
255264
whatsapp:
256265
```
257266
258-
or with env file
267+
Using GitHub Container Registry:
268+
269+
```yml
270+
services:
271+
whatsapp:
272+
image: ghcr.io/aldinokemal/go-whatsapp-web-multidevice
273+
container_name: whatsapp
274+
restart: always
275+
ports:
276+
- "3000:3000"
277+
volumes:
278+
- whatsapp:/app/storages
279+
command:
280+
- rest
281+
- --basic-auth=admin:admin
282+
- --port=3000
283+
- --debug=true
284+
- --os=Chrome
285+
- --account-validation=false
286+
287+
volumes:
288+
whatsapp:
289+
```
290+
291+
or with env file (Docker Hub):
259292
260293
```yml
261294
services:
@@ -278,6 +311,29 @@ volumes:
278311
whatsapp:
279312
```
280313
314+
or with env file (GitHub Container Registry):
315+
316+
```yml
317+
services:
318+
whatsapp:
319+
image: ghcr.io/aldinokemal/go-whatsapp-web-multidevice
320+
container_name: whatsapp
321+
restart: always
322+
ports:
323+
- "3000:3000"
324+
volumes:
325+
- whatsapp:/app/storages
326+
environment:
327+
- APP_BASIC_AUTH=admin:admin
328+
- APP_PORT=3000
329+
- APP_DEBUG=true
330+
- APP_OS=Chrome
331+
- APP_ACCOUNT_VALIDATION=false
332+
333+
volumes:
334+
whatsapp:
335+
```
336+
281337
### Production Mode (binary)
282338
283339
- download binary from [release](https://github.com/aldinokemal/go-whatsapp-web-multidevice/releases)
@@ -352,7 +408,7 @@ You can fork or edit this source code !
352408
| ✅ | Set Group Locked | POST | /group/locked |
353409
| ✅ | Set Group Announce | POST | /group/announce |
354410
| ✅ | Set Group Topic | POST | /group/topic |
355-
| ✅ | Get Group Invite Link | GET | /group/:group_id/invite-link |
411+
| ✅ | Get Group Invite Link | GET | /group/invite-link |
356412
| ✅ | Unfollow Newsletter | POST | /newsletter/unfollow |
357413
| ✅ | Get Chat List | GET | /chats |
358414
| ✅ | Get Chat Messages | GET | /chat/:chat_jid/messages |

0 commit comments

Comments
 (0)