diff --git a/server/docs/quickstart.md b/server/docs/quickstart.md index d8a7534fb5..683eb7dce8 100644 --- a/server/docs/quickstart.md +++ b/server/docs/quickstart.md @@ -12,6 +12,12 @@ your terminal: sh -c "$(curl -fsSL https://raw.githubusercontent.com/ente-io/ente/main/server/quickstart.sh)" ``` +> [!TIP] +> +> If you don't want to run via curl, you can alternatively download +> [quickstart.sh](https://github.com/ente-io/ente/blob/main/server/quickstart.sh), +> `chmod +x` it and then run it with `./quickstart.sh`. + After the Docker compose cluster starts, you can open the Ente web app at http://localhost:3000. @@ -37,12 +43,15 @@ The script first creates a directory named `my-ente` and changes to it. Then it creates a Docker compose file (`compose.yaml`) from a template, and a `museum.yaml` with fresh autogenerated credentials. -Finally, it start the Docker compose cluster running +Finally, it start the Docker compose cluster running the following services on 3 +open ports: -- Ente's own server (museum) -- Ente's web app -- Postgres (DB) -- Minio (S3 storage) +| Service | Port | Notes | +| ----------- | -------- | ----------------------- | +| museum | `:8080` | Ente's API server | +| web | `:3000` | Ente Photos web app | +| postgres | | DB | +| minio | `:3200` | S3 | For each of these, it'll use the latest published Docker image. @@ -86,7 +95,9 @@ on your system. All persistent data is saved in volumes managed by Docker. > [!CAUTION] > -> You can clear these volumes by +> If you delete the `my-ente` folder, the volumes will still persist. So if you +> want to recreate everything from scratch, you can clear these Docker volumes +> (`my-ente_postgres-data` and `my-ente_minio-data`) by > > ```sh > cd /path/to/my-ente diff --git a/server/quickstart.sh b/server/quickstart.sh index 96d34788d1..16624b2337 100755 --- a/server/quickstart.sh +++ b/server/quickstart.sh @@ -98,11 +98,11 @@ services: postgres: image: postgres:15 environment: - POSTGRES_USER: pg-user + POSTGRES_USER: pguser POSTGRES_PASSWORD: $pg_pass POSTGRES_DB: ente_db healthcheck: - test: pg_isready -q -d ente_db -U pg-user + test: pg_isready -q -d ente_db -U pguser start_period: 40s start_interval: 1s volumes: @@ -155,7 +155,7 @@ db: host: postgres port: 5432 name: ente_db - user: pg-user + user: pguser password: $pg_pass s3: