docs: Include new SSL-mode env var in deployment docs (#347)

electric-sql · Aug 22, 2023 · 38e1270 · 38e1270
1 parent 1c1325d
commit 38e1270
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/docs/api/service.md b/docs/api/service.md
@@ -34,6 +34,7 @@ Everything in the table below that doesn't have a default value is required to r
 | Variable                                                        | Description                                                                                                                                                                                                                                                                                                                                                                       |
 |-----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `DATABASE_URL`                                                  | PostgreSQL connection URL for the database.                                                                                                                                                                                                                                                                                                                                       |
+| `DATABASE_REQUIRE_SSL`<p>&nbsp;&nbsp;(`false`)</p>              | Set to `yes` or `true` to require SSL for the connection to the database. Alternatively configure SSL for the connection by adding `sslmode=require` to [the `DATABASE_URL` parameters](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS). Values set in the `DATABASE_URL` will have precedence.                                                   |
 | `LOGICAL_PUBLISHER_HOST`                                        | Host of this electric instance for the reverse connection from Postgres. It has to be accessible from the Postgres instance that is running at `DATABASE_URL`.                                                                                                                                                                                                                    |
 | `LOGICAL_PUBLISHER_PORT`<p>&nbsp;&nbsp;(`5433`)</p>             | Port number to use for reverse connections from Postgres.                                                                                                                                                                                                                                                                                                                         |
 | `HTTP_API_PORT`<p>&nbsp;&nbsp;(`5050`)</p>                      | Port to expose the HTTP API endpoint on.                                                                                                                                                                                                                                                                                                                                          |