diff --git a/README.md b/README.md index 55c762fb74..68e7ca41f7 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ Web Interface for Mailbox. -## Usage via Docker +## Usage + +### Docker ```shell docker run --env AWS_ACCESS_KEY_ID= \ @@ -13,6 +15,13 @@ docker run --env AWS_ACCESS_KEY_ID= \ harryzcy/mailbox-browser ``` +### Cloudflare Pages & Pages Functions + +1. Clone the repository +1. Create [Cloudflare project](https://developers.cloudflare.com/pages/get-started/guide/) +1. Configure correct environment variables according to [this](#environment-variables) section +1. Run `make cloudflare` + Replace the environment variables with respective values. ## Environment Variables @@ -30,4 +39,5 @@ Replace the environment variables with respective values. | Directory | Description | | --------- | ----------- | | bff | Backend for frontend | +| cloudflare | Cloudflare Pages deployment | | web | Web frontend |