diff --git a/docs/site/content/en/docs/how-to/sessions/index.md b/docs/site/content/en/docs/how-to/sessions/index.md index 88795b3f..fab55a91 100644 --- a/docs/site/content/en/docs/how-to/sessions/index.md +++ b/docs/site/content/en/docs/how-to/sessions/index.md @@ -1,44 +1,15 @@ --- -title : "Sessions" +title: "Sessions" description: "Sessions" lead: "" date: 2020-10-06T08:48:45+00:00 lastmod: 2020-10-06T08:48:45+00:00 draft: false -images: [] +images: [ ] weight: 200 --- -## Saving session ![](/images/versions/plus.png) - -Plus ![](/images/versions/plus.png) version allows you to save "session" state and avoid scanning QR code everytime when -you start a container. - -### File storage - -If you want to save your session and do not scan QR code everytime when you launch WAHA - connect a local file storage -to the container. WAHA stores authentication information in the directory and reuses it after restart. - -[Attach volume](https://docs.docker.com/storage/volumes/) part to the command: -```bash --v `pwd`/.sessions:/app/.sessions -``` - -The full command would be: -```bash -docker run --rm -d -v `pwd`/.sessions:/app/.sessions -p 3000:3000/tcp --name whatsapp-http-api devlikeapro/whatsapp-http-api -``` - -### Remote storage ![](/images/versions/soon.png) - -If you're interested in using some "remote" storage (like Redis or other Databases) to save sessions - please create an -issue on GitHub. - -For instances, it may be useful if you run WAHA in a cluster of servers and do not have shared file storage - -## Multiple sessions ![](/images/versions/plus.png) - -If you want to save server's CPU and Memory - run multiple sessions inside one docker container! +## Session methods ### Start @@ -65,6 +36,10 @@ The response: ] ``` +You can add `?all=true` parameter to the request `GET /api/session?all=True` it'll show you ALL session, +including **STOPPED**, +so you can know which one will be restarted if you set `WHATSAPP_RESTART_ALL_SESSIONS=True` environment variable. + ### Stop In order to stop a new session - call `POST /api/sessions/stop` @@ -78,7 +53,6 @@ In order to stop a new session - call `POST /api/sessions/stop` } ``` - ### Logout In order to log out the session - call `POST /api/sessions/logout` @@ -92,3 +66,53 @@ In order to log out the session - call `POST /api/sessions/logout` } ``` +## Autostart +If you don't want to call `POST /api/sessions/start` for every session each time when the container restart - +you can use set of these environment variables to start sessions for you: + +- `WHATSAPP_RESTART_ALL_SESSIONS=True`: Set this variable to `True` to start all **STOPPED** sessions after container + restarts. By default, this variable is set to `False`. + - Please note that this will start all **STOPPED** sessions, not just the sessions that were working before the restart. You can maintain the session list by + using `POST /api/session/stop` with the `logout: True` parameter or by calling `POST /api/session/logout` to remove + **STOPPED** sessions. You can see all sessions, including **STOPPED** sessions, in the `GET /api/sessions/all=True` + response. +- `WHATSAPP_START_SESSION=session1,session2`: This variable can be used to start sessions with the specified names right + after launching the API. Separate session names with a comma. + + + +## Advanced sessions ![](/images/versions/plus.png) + +Plus ![](/images/versions/plus.png) version allows you to save "session" state and avoid scanning QR code everytime when +you start a container. + +### Storage + +#### File storage + +If you want to save your session and do not scan QR code everytime when you launch WAHA - connect a local file storage +to the container. WAHA stores authentication information in the directory and reuses it after restart. + +[Attach volume](https://docs.docker.com/storage/volumes/) part to the command: + +```bash +-v `pwd`/.sessions:/app/.sessions +``` + +The full command would be: + +```bash +docker run --rm -d -v `pwd`/.sessions:/app/.sessions -p 3000:3000/tcp --name whatsapp-http-api devlikeapro/whatsapp-http-api +``` + +#### Remote storage ![](/images/versions/soon.png) + +If you're interested in using some "remote" storage (like Redis or other Databases) to save sessions - please create an +issue on GitHub. + +For instances, it may be useful if you run WAHA in a cluster of servers and do not have shared file storage + +### Multiple sessions + +If you want to save server's CPU and Memory - run multiple sessions inside one docker container! +