diff --git a/apps/photos/.env.development b/apps/photos/.env.development index 18c1d8da8..0c5a6eacd 100644 --- a/apps/photos/.env.development +++ b/apps/photos/.env.development @@ -45,12 +45,14 @@ # The URL for the shared albums deployment # # The shared albums are served from the photos app code, and "albums.ente.io" is -# a CNAME alias to the main photo app itself. Depending on the query params, the -# root page redirects to "/shared-album". +# a CNAME alias to the main photo app itself. When the main index page loads, it +# checks to see if the host is "albums.ente.io", and if so, redirects to +# /shared-albums. # -# The port here will be :3002 if we run it using `yarn dev:albums`, and :3000 if -# we run it using `yarn dev:photos` (the code running the same is both cases, -# only the port it is exposed on is different). +# This environment variable allows us to check for a host other than +# "albums.ente.io". By setting this to localhost:3002 and running the photos app +# on port 3002 (using `yarn dev:albums`), we can connect to it and emulate the +# production behaviour. # # Enhancement: Consider splitting this into a separate app/ in this repository. # That can also reduce bundle sizes and make it load faster. diff --git a/apps/photos/.env.localhost b/apps/photos/.env.localhost index 96c59df55..ef1bf679d 100644 --- a/apps/photos/.env.localhost +++ b/apps/photos/.env.localhost @@ -7,11 +7,15 @@ # # Equivalent CLI command using environment variables would be # -# NEXT_PUBLIC_ENTE_ENDPOINT=http://localhost:8080 NEXT_PUBLIC_ENTE_ALBUMS_ENDPOINT=http://localhost:3000 NEXT_PUBLIC_ENTE_DIRECT_UPLOAD=true yarn dev:photos +# NEXT_PUBLIC_ENTE_ENDPOINT=http://localhost:8080 NEXT_PUBLIC_ENTE_DIRECT_UPLOAD=true yarn dev:photos # NEXT_PUBLIC_ENTE_ENDPOINT = http://localhost:8080 -NEXT_PUBLIC_ENTE_ALBUMS_ENDPOINT = http://localhost:3000 -# Uncomment this if running using yarn dev:albums -# NEXT_PUBLIC_ENTE_ALBUMS_ENDPOINT = http://localhost:3002 NEXT_PUBLIC_ENTE_DIRECT_UPLOAD = true + +# If you wish to preview how the shared albums work, you can use `yarn +# dev:albums`. The equivalent CLI command using env vars would be +# +# NEXT_PUBLIC_ENTE_ENDPOINT=http://localhost:8080 NEXT_PUBLIC_ENTE_ALBUMS_ENDPOINT=http://localhost:3002 NEXT_PUBLIC_ENTE_DIRECT_UPLOAD=true yarn dev:albums + +NEXT_PUBLIC_ENTE_ALBUMS_ENDPOINT = http://localhost:3002