From fcbc92c637e15b18b887f1b62b4117ba83aa9090 Mon Sep 17 00:00:00 2001 From: Mathias Fredriksson Date: Fri, 12 Aug 2022 18:55:14 +0300 Subject: [PATCH] chore: Update readme with note about embedded database --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 75f0cc255399f..6abd1296fff6d 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ curl -L https://coder.com/install.sh | sh -s -- --help > See [install](docs/install.md) for additional methods. -Once installed, you can start a production deployment with a single command: +Once installed, you can start a production deployment1 with a single command: ```sh # Automatically sets up an external access URL on *.try.coder.app @@ -64,6 +64,8 @@ coder server --tunnel coder server --postgres-url --access-url ``` +> 1 The embedded database is great for trying out Coder with small deployments, but do consider using an external database for increased assurance and control. + Use `coder --help` to get a complete list of flags and environment variables. Use our [quickstart guide](https://coder.com/docs/coder-oss/latest/quickstart) for a full walkthrough. ## Documentation