π End-to-end encrypted cloud for everything.
Dart 2faandroidauthye2eeencryptionend-to-end-encryptionfluttergolanggoogle-photosgoogle-photos-alternativeiosopensourcephotosprivacyprivacy-toolstypescriptzero-knowledge
Tighten server documentation
Manav Rathi9a17b9dcaf87
diff --git a/server/README.md b/server/README.mdindex 377e005bd2..e64b8db303 100644--- a/server/README.md+++ b/server/README.md@@ -58,7 +58,7 @@ Until we get there, museum serves as an assistant for various housekeeping chore- Details about the 3 (yes 3!) clouds where the encrypted data and database are replicated to are [documented here](https://ente.com/reliability)-Museum's architecture is generic enough to support arbitrary end-to-end encrypted storage. While we're currently focusing on building a great photo storage and sharing experience, that's not a limit. For example, we already use museum to also provide an [end-to-end encrypted open source 2FA app with cloud backups](../auth).+Museum's architecture is generic enough to support arbitrary end-to-end encrypted storage. While we're currently focusing on building a great photo storage and sharing experience, that's not a limit. For example, we use museum to provide end-to-end encrypted [2FA](https://ente.com/auth), [document storage](https://ente.com/locker), and [social](https://ente.space).## Self hostingdiff --git a/server/RUNNING.md b/server/RUNNING.mdindex 029cfe4b25..ecc05260e3 100644--- a/server/RUNNING.md+++ b/server/RUNNING.md@@ -6,7 +6,7 @@ You can also run museum directly on your machine if you wish - it is a single stThis document describes these different approaches (you can choose any one), and also outlines configuration.-- [Run using pre-built Docker images](quickstart/README.md)+- [Run using pre-built Docker images](docs/quickstart.md)- [Run using Docker, building image from source](#build-and-run-using-docker)- [Run with Docker, Γ la carte](#pre-built-images)- [Run without Docker](#running-without-docker)diff --git a/server/docs/publish.md b/server/docs/publish.mdindex 3f64743711..12bab8c5ab 100644--- a/server/docs/publish.md+++ b/server/docs/publish.md@@ -1,27 +1,21 @@# Publishing images-There are two different images we publish - internal and external.-## Internal-The internal images can be built and run by triggering the "Server (release)" workflow. You can trigger it either from GitHub's UI on the Actions tab, or use the following command:+Run the "Release (Server)" workflow from GitHub Actions or with:```shgh workflow run server-release.yml```-This will take the latest main, package it into a Docker image, and publish it to our Scaleway registry. From there, we can update our production instances to use this new image (see [deploy/README](../scripts/deploy/README.md)).+It publishes the current commit to our Scaleway registry. See [deploy/README](../scripts/deploy/README.md) for deployment instructions.-## External+## GHCR-Periodically, we republish a new image from an existing known-to-be-good commit to the GitHub Container Registry (GHCR) so that it can be used by folks without needing to clone our repository just for building an image. For more details about the use case, see [docker.md](docker.md).+The "Publish GHCR (Server)" workflow runs on the 15th of each month. It publishes the commit currently deployed in production to `ghcr.io/ente/server`, tagged with both the commit SHA and `latest`.-These images are published automatically by the "Publish (server)" workflow on the 15th of every month. If needed, the workflow can also be manually triggered invoked to publish out of schedule. It can be triggered on the GitHub UI, or by+To run it manually:```sh-gh workflow run server-publish.yml+gh workflow run server-publish-ghcr.yml```--> It uses the commit that is deployed on production museum instances. We can publish from any arbitrary commit really, but by using the commit that's already seen production, we avoid externally publishing images with issues.--Once the workflow completes, the resultant image will be available at `ghcr.io/ente/server`. The image will be tagged by the commit SHA. The latest image will also be tagged, well, "latest".diff --git a/server/space/README.md b/server/space/README.mddeleted file mode 100644index 5d5030c9ee..0000000000--- a/server/space/README.md+++ /dev/null@@ -1,54 +0,0 @@-# Space Module--This module is the top-level home for space functionality in `server`.--## Layout--- `space/api`: thin Gin handlers and route registration-- `space/controller`: space business-logic surfaces, split by concern-- `space/repo`: Postgres and storage dependencies for space concerns-- `space/models`: space request/response and module-local types--The Rust space client lives alongside the rest of the Ente Rust crates at-`rust/crates/space`, not inside `server/space`.--The space root key bootstrap remains on the existing `/user-entity/key` endpoint via `userentity.Space`.--## Routes--Selected private Space routes are mounted under `/spaces/:spaceID/*`.-Public Space reads also use `/spaces/:spaceID/*`; legacy `/space/*` remains only for public slug lookup and link-session bootstrap endpoints.--## Local env overrides--Use a separate Postgres DB and Garage-backed S3 buckets by setting:--```bash-export ENVIRONMENT=local--export ENTE_DB_HOST=localhost-export ENTE_DB_PORT=5432-export ENTE_DB_NAME=ente3_space-export ENTE_DB_USER=postgres-export ENTE_DB_PASSWORD=postgres-export ENTE_DB_SSLMODE=disable--export ENTE_S3_ARE_LOCAL_BUCKETS=true-export ENTE_S3_USE_PATH_STYLE_URLS=true-export ENTE_S3_HOT_STORAGE_PRIMARY=b2-eu-cen-export ENTE_S3_HOT_STORAGE_SECONDARY=wasabi-eu-central-2-v3--export ENTE_S3_B2_EU_CEN_KEY=garage-access-key-export ENTE_S3_B2_EU_CEN_SECRET=garage-secret-key-export ENTE_S3_B2_EU_CEN_ENDPOINT=http://127.0.0.1:3900-export ENTE_S3_B2_EU_CEN_REGION=garage-export ENTE_S3_B2_EU_CEN_BUCKET=ente3-space-primary--export ENTE_S3_WASABI_EU_CENTRAL_2_V3_KEY=garage-access-key-export ENTE_S3_WASABI_EU_CENTRAL_2_V3_SECRET=garage-secret-key-export ENTE_S3_WASABI_EU_CENTRAL_2_V3_ENDPOINT=http://127.0.0.1:3900-export ENTE_S3_WASABI_EU_CENTRAL_2_V3_REGION=garage-export ENTE_S3_WASABI_EU_CENTRAL_2_V3_BUCKET=ente3-space-secondary-```--If derived space assets later need a separate bucket, add the matching `ENTE_S3_*` credentials for that bucket ID too.