Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
199ocero authored Jun 1, 2024
1 parent 9cff8ed commit 556549d
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,16 @@ MAILIFYFLOW_NODE_PATH=full-path-to-your-node
- Create a subscription within your selected SNS topic, using `HTTPS` as the protocol. You can use `expose` or `ngrok` to expose your local environment; in production, this is not necessary.
- Use the exposed URL in the `Endpoint` field of your SNS, appending `/webhooks/ses` at the end.

> [!IMPORTANT]
> ***Please ensure that you do not disable or cancel your `expose` or `ngrok`, as it needs to listen to all events coming from Amazon SNS. During development, it's crucial to keep it running, but in production, you can turn it off.***
**Steps below create AWS access key, secret access key, and region:**
- Create an IAM group and assign the `AmazonSESFullAccess` and `AmazonSNSFullAccess` permissions.
- Create a new IAM user and add them to the group you created.
- Once the user is created, obtain the access key and secret key, and ensure you use the same region where your Amazon SES is set up.

Lastly, the system uses jobs, so you will need to run `php artisan queue:work` for the local environment. For production, you will need to use a tool like `supervisor` and Laravel provides [documentation](https://laravel.com/docs/11.x/queues#running-the-queue-worker) for this. Additionally, the system having scheduled commands and you need to setup your server using the provided [guide.](https://laravel.com/docs/11.x/scheduling#running-the-scheduler)

## Authors

- [Jay-Are Ocero](https://github.com/199ocero)
Expand Down

0 comments on commit 556549d

Please sign in to comment.