From 077e3694c7506459dae00f032da2d1143e6d655d Mon Sep 17 00:00:00 2001 From: Mark Milligan Date: Wed, 2 Nov 2022 17:26:33 -0500 Subject: [PATCH 1/2] chore: 1. add psql URL for built-in db 2. repair workspace CLI --- docs/admin/configure.md | 9 +++++++++ docs/workspaces.md | 10 ++++++++++ 2 files changed, 19 insertions(+) diff --git a/docs/admin/configure.md b/docs/admin/configure.md index 46de50192b448..abafa0ffa2acd 100644 --- a/docs/admin/configure.md +++ b/docs/admin/configure.md @@ -37,6 +37,15 @@ downloaded from Maven (https://repo1.maven.org/maven2) and store all data in the > Postgres 13 is the minimum supported version. +If you are using the built-in PostgreSQL deployment and need to use `psql` (aka +the PostgreSQL interactive terminal), output the connection URL with the following command: + +```console +$ coder server postgres-builtin-url + +psql "postgres://coder@localhost:49627/coder?sslmode=disable&password=feU...yI1" +``` + ## System packages If you've installed Coder via a [system package](../install/packages.md) Coder, you can diff --git a/docs/workspaces.md b/docs/workspaces.md index 2aef3a4d54a68..cd84aeb3b09b7 100644 --- a/docs/workspaces.md +++ b/docs/workspaces.md @@ -70,6 +70,16 @@ The workspace will be stopped and started: coder update ``` +## Repairing workspaces + +Use the following command to prompt the user to re-enter template input +variables in an existing workspace. e.g., a workspace fails to build when the +workspace state is out of sync with updates to the workspace's template. + +```console +coder update --always-prompt +``` + ## Logging Coder stores macOS and Linux logs at the following locations: From 8b98dd681c4693147f5c621177534a9562ef132a Mon Sep 17 00:00:00 2001 From: Ammar Bandukwala Date: Wed, 2 Nov 2022 22:52:31 +0000 Subject: [PATCH 2/2] Minor touchups --- docs/admin/configure.md | 3 +-- docs/workspaces.md | 6 +++--- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/admin/configure.md b/docs/admin/configure.md index abafa0ffa2acd..9acf0ad9433fa 100644 --- a/docs/admin/configure.md +++ b/docs/admin/configure.md @@ -42,8 +42,7 @@ the PostgreSQL interactive terminal), output the connection URL with the followi ```console $ coder server postgres-builtin-url - -psql "postgres://coder@localhost:49627/coder?sslmode=disable&password=feU...yI1" +$ psql "postgres://coder@localhost:49627/coder?sslmode=disable&password=feU...yI1" ``` ## System packages diff --git a/docs/workspaces.md b/docs/workspaces.md index cd84aeb3b09b7..8aa0fdfb6c8af 100644 --- a/docs/workspaces.md +++ b/docs/workspaces.md @@ -72,9 +72,9 @@ coder update ## Repairing workspaces -Use the following command to prompt the user to re-enter template input -variables in an existing workspace. e.g., a workspace fails to build when the -workspace state is out of sync with updates to the workspace's template. +Use the following command to re-enter template input +variables in an existing workspace. This command is useful when a workspace fails +to build because its state is out of sync with the template. ```console coder update --always-prompt