UBERF-11869: Add instructions to configure web push notifications (#161)

* UBERF-11869: Add instructions to configure web push notifications

Signed-off-by: Artem Savchenko <armisav@gmail.com>

* UBERF-11869: Clean up

Signed-off-by: Artem Savchenko <armisav@gmail.com>

---------

Signed-off-by: Artem Savchenko <armisav@gmail.com>
This commit is contained in:
Artyom Savchenko
2025-06-26 11:31:53 +07:00
committed by GitHub
parent eed3f543ef
commit f22d0b9c72
+36
View File
@@ -104,6 +104,42 @@ Add these keys into `compose.yaml` in section `services:ses:environment`:
- PUSH_PRIVATE_KEY=your private key
```
## Web Push Notifications
> [!NOTE]
> In version 0.7.x and later, the `ses` service has been replaced with the `notification` service for web push notifications and the `mail` service for sending emails using SES. The environment variables `SECRET_KEY`, `PUSH_PUBLIC_KEY`, and `PUSH_PRIVATE_KEY` are not required for web push notifications in 0.7.x.
To enable web push notifications in Huly, you need to configure the SES service with the VAPID keys.
### Step 1: Configure the Transactor Service
Add `WEB_PUSH_URL` to `transactor` container:
```yaml
transactor:
...
environment:
- WEB_PUSH_URL=http://ses:3335
...
```
### Step 2: Configure the SES Service
Add the `ses` container to your `docker-compose.yaml` file with the generated VAPID keys:
```yaml
ses:
image: hardcoreeng/ses:v0.6.501
environment:
- PORT=3335
- SOURCE=mail@example.com
- ACCESS_KEY=none
- SECRET_KEY=none
- PUSH_PUBLIC_KEY=${PUSH_PUBLIC_KEY}
- PUSH_PRIVATE_KEY=${PUSH_PRIVATE_KEY}
restart: unless-stopped
```
## Mail Service
The Mail Service is responsible for sending email notifications and confirmation emails during user login or signup processes. It can be configured to send emails through either an SMTP server or Amazon SES (Simple Email Service), but not both at the same time.