beenull/ente
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
ente/web/docs/deploy.md
Manav Rathi e15c7e1642 Move into web/
2024-03-01 12:21:07 +05:30

2.7 KiB
Raw Blame History

Deploying the web apps

The various web apps (Ente Photos, Ente Auth) are deployed on Cloudflare Pages. They also use Cloudflare Workers for some tasks.

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 Ente Auth app
  • cast - The cast app, which can be thought of as an independent subset of Photos app functionality
  • ... and more

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 docs).

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
  • accounts.ente.io: accounts-release
  • cast.ente.io: cast-release

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.

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 build:foo. Currently this is set to 20.11.1. The major version here should 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.

Adding a new app

  1. Add a mapping in scripts/deploy.sh.

  2. Add a Custom Domain in Cloudflare pointing to this branch's deployment.