Skip to content

Commit

Permalink
Document cloudflare deployment (#488)
Browse files Browse the repository at this point in the history
  • Loading branch information
harryzcy authored Sep 24, 2023
1 parent 2bba74f commit 96353f3
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

Web Interface for Mailbox.

## Usage via Docker
## Usage

### Docker

```shell
docker run --env AWS_ACCESS_KEY_ID=<AWS_ACCESS_KEY_ID> \
Expand All @@ -13,6 +15,13 @@ docker run --env AWS_ACCESS_KEY_ID=<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
Expand All @@ -30,4 +39,5 @@ Replace the environment variables with respective values.
| Directory | Description |
| --------- | ----------- |
| bff | Backend for frontend |
| cloudflare | Cloudflare Pages deployment |
| web | Web frontend |

0 comments on commit 96353f3

Please sign in to comment.