diff --git a/README.md b/README.md index 157510b19fbda..ccc01b3fc908c 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ Once installed, you can start a production deployment1 with a single # Automatically sets up an external access URL on *.try.coder.app coder server -# Requires a PostgreSQL instance and external access URL +# Requires a PostgreSQL instance (version 13 or higher) and external access URL coder server --postgres-url --access-url ``` @@ -95,7 +95,7 @@ Join our community on [Discord](https://coder.com/chat?utm_source=github.com/cod ## Contributing -If you're using Coder in your organization, please try to add your company name to the [ADOPTERS.md](./ADOPTERS.md). It really helps the project to gain momentum and credibility. It's a small contribution back to the project with a big impact. +If you're using Coder in your organization, please try to add your company name to the [ADOPTERS.md](./ADOPTERS.md). It really helps the project to gain momentum and credibility. It's a small contribution back to the project with a big impact. Read the [contributing docs](https://coder.com/docs/coder-oss/latest/CONTRIBUTING). diff --git a/docs/admin/configure.md b/docs/admin/configure.md index 8e70475fe2ac4..e1607d9672162 100644 --- a/docs/admin/configure.md +++ b/docs/admin/configure.md @@ -29,6 +29,8 @@ Coder uses a PostgreSQL database to store users, workspace metadata, and other d Use `CODER_PG_CONNECTION_URL` to set the database that Coder connects to. If unset, PostgreSQL binaries will be downloaded from Maven (https://repo1.maven.org/maven2) and store all data in the config root. +> Postgres 13 is the minimum supported version. + ## System packages If you've installed Coder via a [system package](../install/packages.md) Coder, you can diff --git a/docs/install/binary.md b/docs/install/binary.md index bde79b0422fdc..20cd3f164374e 100644 --- a/docs/install/binary.md +++ b/docs/install/binary.md @@ -17,7 +17,7 @@ Coder publishes self-contained .zip and .tar.gz archives in [GitHub releases](ht # Automatically sets up an external access URL on *.try.coder.app coder server - # Requires a PostgreSQL instance and external access URL + # Requires a PostgreSQL instance (version 13 or higher) and external access URL coder server --postgres-url --access-url ``` diff --git a/docs/install/docker.md b/docs/install/docker.md index 565bdd2f59884..73124a13fcc3a 100644 --- a/docs/install/docker.md +++ b/docs/install/docker.md @@ -30,9 +30,9 @@ Learn more about Coder's [configuration options](../admin/configure.md). ## Run Coder with access URL and external PostgreSQL (recommended) -For production deployments, we recommend using an external PostgreSQL database. -Set `ACCESS_URL` to the external URL that users and workspaces will use to -connect to Coder. +For production deployments, we recommend using an external PostgreSQL database +(version 13 or higher). Set `ACCESS_URL` to the external URL that users and +workspaces will use to connect to Coder. ```sh docker run --rm -it \