diff --git a/docs/deploy.md b/docs/deploy.md index 3c7129187..8838204c0 100644 --- a/docs/deploy.md +++ b/docs/deploy.md @@ -1,24 +1,24 @@ # Deploying the web apps -The various web apps (ente Photos, ente Auth) are deployed on Cloudflare Pages. +The various web apps (Ente Photos, Ente Auth) are deployed on Cloudflare Pages. They also use Cloudflare Workers for some tasks. -The web app repository deploys multiple different apps (the photos app, the auth -app). Some of them get deployed to multiple different endpoints (e.g. the main -branch of photos app gets deployed to testing.ente.io, the while the -photos-release branch is the production deployment). +This repository deploys multiple different apps (the Photos app, the Auth app). +Some of them get deployed to multiple different endpoints (e.g. the main branch +of photos app gets deployed to testing.ente.io, the while the photos-release +branch is the production deployment). The apps are under the app directory: -- photos - The ente Photos app -- auth - The Authenticator app +- photos - The Ente Photos app +- auth - The Ente Auth app - cast - The cast app, which can be thought of as an independent subset of - Photos app functionality. -- ... and more in the future. + Photos app functionality +- ... and more -We have configured the GitHub integration provided by Cloudflare Pages app on -the photos-web repository. This integration watches for pushes to all branches. -In all cases, it runs the same script, `scripts/deploy.sh`. +For deploying, we've added the GitHub integration provided by Cloudflare Pages +app to this repository. This integration watches for pushes to all branches. In +all cases, it runs the same script, `scripts/deploy.sh`. Internally it uses the `CF_PAGES_BRANCH` environment variable to decide what exactly to build ([CF @@ -39,8 +39,7 @@ deploy the code to _web.ente.io_. ## Adding a new app -1. Add a mapping in `scripts/deploy.sh` (in the [photos-web - repository](https://github.com/ente-io/photos-web)). +1. Add a mapping in `scripts/deploy.sh`. 2. Add a [Custom Domain in Cloudflare](https://developers.cloudflare.com/pages/how-to/custom-branch-aliases/)