2024-02-20 05:52:22 +00:00
|
|
|
# Deploying the web apps
|
|
|
|
|
|
2024-02-20 05:56:11 +00:00
|
|
|
The various web apps (Ente Photos, Ente Auth) are deployed on Cloudflare Pages.
|
2024-02-20 05:52:22 +00:00
|
|
|
They also use Cloudflare Workers for some tasks.
|
|
|
|
|
|
2024-02-20 05:56:11 +00:00
|
|
|
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).
|
2024-02-20 05:52:22 +00:00
|
|
|
|
|
|
|
|
The apps are under the app directory:
|
|
|
|
|
|
2024-02-20 05:56:11 +00:00
|
|
|
- photos - The Ente Photos app
|
|
|
|
|
- auth - The Ente Auth app
|
2024-02-20 05:52:22 +00:00
|
|
|
- cast - The cast app, which can be thought of as an independent subset of
|
2024-02-20 05:56:11 +00:00
|
|
|
Photos app functionality
|
|
|
|
|
- ... and more
|
2024-02-20 05:52:22 +00:00
|
|
|
|
2024-02-20 05:56:11 +00:00
|
|
|
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`.
|
2024-02-20 05:52:22 +00:00
|
|
|
|
|
|
|
|
Internally it uses the `CF_PAGES_BRANCH` environment variable to decide what
|
|
|
|
|
exactly to build ([CF
|
|
|
|
|
docs](https://developers.cloudflare.com/pages/how-to/build-commands-branches/)).
|
|
|
|
|
|
|
|
|
|
Then, for some special branches, we have configured CNAME aliases (Cloudflare
|
|
|
|
|
calls them Custom Domains) to give a stable URL to some of these deployments
|
|
|
|
|
Here is a potentially out of date list of CNAMEs and the corresponding branch;
|
|
|
|
|
see the Cloudflare dashboard for the latest:
|
|
|
|
|
|
|
|
|
|
- _testing.ente.io_: `main`
|
|
|
|
|
- _web.ente.io_: `photos-release`
|
|
|
|
|
- _auth.ente.io_: `auth-release`
|
2024-02-24 11:31:07 +00:00
|
|
|
- _accounts.ente.io_: `accounts-release`
|
|
|
|
|
- _cast.ente.io_: `cast-release`
|
2024-02-20 05:52:22 +00:00
|
|
|
|
|
|
|
|
Thus to trigger a, say, production deployment of the photos app, we can open and
|
|
|
|
|
merge a PR into the `photos-release` branch. Cloudflare will then build and
|
|
|
|
|
deploy the code to _web.ente.io_.
|
|
|
|
|
|
2024-02-24 11:31:07 +00:00
|
|
|
Apart from this, there are also some subdomains:
|
|
|
|
|
|
|
|
|
|
- `albums.ente.io` is a CNAME alias to the production deployment
|
|
|
|
|
(`web.ente.io`). However, when the code detects that it is being served from
|
|
|
|
|
`albums.ente.io`, it redirects to the `/shared-albums` page (Enhancement:
|
|
|
|
|
serve it as a separate app with a smaller bundle size).
|
|
|
|
|
|
|
|
|
|
- `payments.ente.io` and `family.ente.io` are currently in a separate
|
|
|
|
|
repositories (Enhancement: bring them in here).
|
|
|
|
|
|
|
|
|
|
In Cloudflare Pages setting the following environment variables are defined:
|
|
|
|
|
|
|
|
|
|
- `NODE_VERSION`: Determines which version of Node is used when we do `yarn
|
2024-02-24 11:35:49 +00:00
|
|
|
build:foo`. Currently this is set to `20.11.1`. The major version here should
|
2024-02-24 11:31:07 +00:00
|
|
|
match that of `@types/node` in our dev dependencies.
|
|
|
|
|
|
|
|
|
|
- `SENTRY_AUTH_TOKEN`: An encrypted environment variable that is used by the
|
|
|
|
|
Sentry Webpack Plugin to upload sourcemaps during the build.
|
|
|
|
|
|
2024-02-20 05:52:22 +00:00
|
|
|
## Adding a new app
|
|
|
|
|
|
2024-02-20 05:56:11 +00:00
|
|
|
1. Add a mapping in `scripts/deploy.sh`.
|
2024-02-20 05:52:22 +00:00
|
|
|
|
|
|
|
|
2. Add a [Custom Domain in
|
|
|
|
|
Cloudflare](https://developers.cloudflare.com/pages/how-to/custom-branch-aliases/)
|
|
|
|
|
pointing to this branch's deployment.
|
