chore(docs): New guides on deploying to DigitalOcean (electric-sql#721)

gregzo · Dec 13, 2023 · dc0008d · dc0008d
1 parent a69cf5e
commit dc0008d
Show file tree

Hide file tree

Showing 16 changed files with 363 additions and 7 deletions.
diff --git a/docs/integrations/deployment/digital-ocean.md b/docs/integrations/deployment/digital-ocean.md
diff --git a/docs/integrations/deployment/digital-ocean/create-app/activity.png b/docs/integrations/deployment/digital-ocean/create-app/activity.png
diff --git a/docs/integrations/deployment/digital-ocean/create-app/component-settings.png b/docs/integrations/deployment/digital-ocean/create-app/component-settings.png
diff --git a/docs/integrations/deployment/digital-ocean/create-app/edit-plan.png b/docs/integrations/deployment/digital-ocean/create-app/edit-plan.png
diff --git a/docs/integrations/deployment/digital-ocean/create-app/env-vars.png b/docs/integrations/deployment/digital-ocean/create-app/env-vars.png
diff --git a/docs/integrations/deployment/digital-ocean/create-app/environment.png b/docs/integrations/deployment/digital-ocean/create-app/environment.png
diff --git a/docs/integrations/deployment/digital-ocean/create-app/info.png b/docs/integrations/deployment/digital-ocean/create-app/info.png
diff --git a/docs/integrations/deployment/digital-ocean/create-app/resources.png b/docs/integrations/deployment/digital-ocean/create-app/resources.png
diff --git a/docs/integrations/deployment/digital-ocean/create-app/review.png b/docs/integrations/deployment/digital-ocean/create-app/review.png
diff --git a/docs/integrations/deployment/digital-ocean/create-droplet/choose-auth.png b/docs/integrations/deployment/digital-ocean/create-droplet/choose-auth.png
diff --git a/docs/integrations/deployment/digital-ocean/create-droplet/choose-image.png b/docs/integrations/deployment/digital-ocean/create-droplet/choose-image.png
diff --git a/docs/integrations/deployment/digital-ocean/create-droplet/choose-region.png b/docs/integrations/deployment/digital-ocean/create-droplet/choose-region.png
diff --git a/docs/integrations/deployment/digital-ocean/create-droplet/choose-size.png b/docs/integrations/deployment/digital-ocean/create-droplet/choose-size.png
diff --git a/docs/integrations/deployment/digital-ocean/create-droplet/finalize-details.png b/docs/integrations/deployment/digital-ocean/create-droplet/finalize-details.png
diff --git a/docs/integrations/deployment/docker.md b/docs/integrations/deployment/docker.md
@@ -19,9 +19,8 @@ docker run \
     -p 5133:5133 \
     -p 5433:5433 \
     -p 65432:65432 \
+    -t \
     electricsql/electric
 ```
 
-If you'd like to run Electric and Postgres together in Docker, feel free to use the [Docker Compose file][1] from our starter template as a reference.
-
-[1]: https://github.com/electric-sql/electric/blob/main/examples/starter/template/backend/compose/docker-compose.yaml
+Alternatively, using Docker Compose we can configure an instance of the Electric sync service in a `compose.yaml` file stored locally and deploy it to a remote machine that has the Docker daemon running. See instructions for deploying Electric to a [Digital Ocean Droplet](digital-ocean#deploying-electric-using-docker-compose) for an example of such setup.
diff --git a/docs/usage/installation/service.md b/docs/usage/installation/service.md
@@ -13,7 +13,7 @@ You can run the [pre-packaged Docker images](#images) published on Docker Hub, o
 
 The Electric sync service is configured using environment variables. The three required variables are:
 
-- `DATABASE_URL` in the format of a Postgres [Connection URI](https://www.postgresql.org/docs/current/libpq-connect.html#id-1.7.3.8.3.6)
+- `DATABASE_URL` in the format of a Postgres [Connection URI](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS)
 - `LOGICAL_PUBLISHER_HOST` that the sync service is running on (must be accessible from the Postgres instance to establish an inbound replication subscription)
 - `PG_PROXY_PASSWORD` to safe-guard access to the [Migrations proxy](../data-modelling/migrations.md#migrations-proxy)
 
@@ -40,6 +40,7 @@ docker run \
     -p 5133:5133 \
     -p 5433:5433 \
     -p 65432:65432 \
+    -t \
     electricsql/electric
 ```
 
@@ -55,7 +56,7 @@ volumes:
 
 services:
   pg:
-    image: postgres
+    image: postgres:14-alpine
     environment:
       POSTGRES_PASSWORD: pg_password
     command:
@@ -64,7 +65,8 @@ services:
     ports:
       - 5432:5432
     restart: always
-    volumes: pg_data:/var/lib/postgresql/data
+    volumes:
+      - pg_data:/var/lib/postgresql/data
 
   electric:
     image: electricsql/electric
@@ -106,7 +108,8 @@ docker run \
     -p 5133:5133 \
     -p 5433:5433 \
     -p 65432:65432 \
-    -it electric:local-build
+    -t \
+    electric:local-build
 ```
 
 ## Elixir