From 3196ad3d191c65e94a56109037d7993f3b02f4ac Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Fri, 3 Dec 2021 13:32:42 -0600 Subject: [PATCH 1/7] Move licensing doc to admin section --- {setup => admin}/licensing.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {setup => admin}/licensing.md (100%) diff --git a/setup/licensing.md b/admin/licensing.md similarity index 100% rename from setup/licensing.md rename to admin/licensing.md From f207de48896ecab8625685ecb6f0f8cef5ffee65 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Fri, 3 Dec 2021 13:34:05 -0600 Subject: [PATCH 2/7] update manifest --- manifest.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/manifest.json b/manifest.json index 491fadb6e..32f91800a 100644 --- a/manifest.json +++ b/manifest.json @@ -167,9 +167,6 @@ { "path": "./setup/configuration.md" }, - { - "path": "./setup/licensing.md" - }, { "path": "./setup/updating/index.md", "children": [ @@ -324,11 +321,14 @@ { "path": "./admin/devurls.md" }, + { + "path": "./admin/stun.md" + }, { "path": "./admin/git.md" }, { - "path": "./admin/stun.md" + "path": "./admin/licensing.md" }, { "path": "./admin/telemetry.md" From 73aaeddb2c4a41446946350ec0ac94b022155ed5 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Fri, 3 Dec 2021 13:35:33 -0600 Subject: [PATCH 3/7] move Coder for Docker to guides --- manifest.json | 6 +-- setup/docker.md | 100 ------------------------------------------------ 2 files changed, 3 insertions(+), 103 deletions(-) delete mode 100644 setup/docker.md diff --git a/manifest.json b/manifest.json index 32f91800a..25a67490f 100644 --- a/manifest.json +++ b/manifest.json @@ -182,9 +182,6 @@ "path": "./setup/air-gapped/infrastructure.md" } ] - }, - { - "path": "./setup/docker.md" } ] }, @@ -409,6 +406,9 @@ { "path": "./guides/deployments/index.md", "children": [ + { + "path": "./guides/deployments/docker.md" + }, { "path": "./guides/deployments/archive-install.md" }, diff --git a/setup/docker.md b/setup/docker.md deleted file mode 100644 index 6224e6684..000000000 --- a/setup/docker.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: "Coder for Docker" -description: Learn how to run Coder with Docker. ---- - -Coder for Docker allows you to deploy Coder to any machine on which Docker runs -quickly. - -## Prerequisites - -You must be using a machine that is running Linux/macOS and has -[Docker Desktop](https://www.docker.com/products/docker-desktop) installed. - -## Installing Coder for Docker - -1. Launch Docker Desktop. - -1. If you've previously installed Coder, run `sudo rm -rf ~/.coder` in the - terminal. - -1. In the terminal, run the following to download the resources you need, - include the images, and set up your Coder deployment (if you're using the - terminal in Docker Desktop, omit the slashes and run as a single-line - command): - - ```console - docker run --rm -it \ - -p 7080:7080 \ - -v /var/run/docker.sock:/var/run/docker.sock \ - -v ~/.coder:/var/run/coder \ - -e DEVURL_HOST="*.mycompany.com" \ - codercom/coder:1.25.0 - ``` - - When this process is complete, Coder will print the URL you can use to access - your deployment, as well as the admin credentials you'll need to log in: - - ```console - > Welcome to Coder! 👋 - > Head to http://localhost:7080 to get started! - - > 🙋 Username: admin - > 🔑 Password: 5h...7n - ``` - - Make a note of these values, because you will need these in the subsequent - step. - -1. Launch a web browser and navigate to the URL provided by Coder (e.g., - `http://localhost:7080`). Log in using the credentials Coder provided. - -1. At this point, you can [create a workspace](../workspaces/getting-started.md) - using one of the **Packaged** images by clicking on **New workspace** in the - center of the UI. - -At this point, you're ready to use your workspace. - -## Usage notes - -When running, Docker Desktop displays both your Coder deployment and your -workspace. - -![Docker Desktop view](../assets/setup/docker-desktop.png) - -You can also view runtime information (i.e., API calls) in the console where you -started your deployment: - -![Console realtime info](../assets/setup/coder-for-docker-console.png) - -## Dev URLs - -To use a dev URL, set an environment variable when issuing the `docker run` -command to start your deployment (be sure to replace the placeholder URL): - -```console -DEVURL_HOST="*.mycompany.com" -``` - -For example: - -```console -docker run --rm -it -p 7080:7080 -v /var/run/docker.sock:/var/run/docker.sock -v ~/.coder:/var/run/coder codercom/coder:1.25.0 -e DEVURL_HOST="*.mycompany.com" -``` - -## Scaling - -Coder for Docker is limited by the resources of the machine on which it runs. We -recommend using Kubernetes or AWS EC2 providers if you would like automatic -multi-machine scaling. - -For organizations, we recommend one Docker host per team of 5-10 developers. - -## Known issues - -Currently, Coder for Docker does not support: - -- External PostgreSQL databases -- The use of your own TLS certificates. If you'd like to use TLS with Coder for - Docker, you'll need to run Coder behind a reverse proxy (e.g., Caddy or NGINX) - and terminate TLS at that point. From 96fa816f1c91dfd549834d2004ea92194a430b4f Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Fri, 3 Dec 2021 13:38:38 -0600 Subject: [PATCH 4/7] move Coder for Docker, Upgrade guide --- guides/deployments/docker.md | 100 ++++++++++++++++++ manifest.json | 16 +-- {setup/updating => upgrade}/considerations.md | 0 {setup/updating => upgrade}/index.md | 0 4 files changed, 108 insertions(+), 8 deletions(-) create mode 100644 guides/deployments/docker.md rename {setup/updating => upgrade}/considerations.md (100%) rename {setup/updating => upgrade}/index.md (100%) diff --git a/guides/deployments/docker.md b/guides/deployments/docker.md new file mode 100644 index 000000000..6224e6684 --- /dev/null +++ b/guides/deployments/docker.md @@ -0,0 +1,100 @@ +--- +title: "Coder for Docker" +description: Learn how to run Coder with Docker. +--- + +Coder for Docker allows you to deploy Coder to any machine on which Docker runs +quickly. + +## Prerequisites + +You must be using a machine that is running Linux/macOS and has +[Docker Desktop](https://www.docker.com/products/docker-desktop) installed. + +## Installing Coder for Docker + +1. Launch Docker Desktop. + +1. If you've previously installed Coder, run `sudo rm -rf ~/.coder` in the + terminal. + +1. In the terminal, run the following to download the resources you need, + include the images, and set up your Coder deployment (if you're using the + terminal in Docker Desktop, omit the slashes and run as a single-line + command): + + ```console + docker run --rm -it \ + -p 7080:7080 \ + -v /var/run/docker.sock:/var/run/docker.sock \ + -v ~/.coder:/var/run/coder \ + -e DEVURL_HOST="*.mycompany.com" \ + codercom/coder:1.25.0 + ``` + + When this process is complete, Coder will print the URL you can use to access + your deployment, as well as the admin credentials you'll need to log in: + + ```console + > Welcome to Coder! 👋 + > Head to http://localhost:7080 to get started! + + > 🙋 Username: admin + > 🔑 Password: 5h...7n + ``` + + Make a note of these values, because you will need these in the subsequent + step. + +1. Launch a web browser and navigate to the URL provided by Coder (e.g., + `http://localhost:7080`). Log in using the credentials Coder provided. + +1. At this point, you can [create a workspace](../workspaces/getting-started.md) + using one of the **Packaged** images by clicking on **New workspace** in the + center of the UI. + +At this point, you're ready to use your workspace. + +## Usage notes + +When running, Docker Desktop displays both your Coder deployment and your +workspace. + +![Docker Desktop view](../assets/setup/docker-desktop.png) + +You can also view runtime information (i.e., API calls) in the console where you +started your deployment: + +![Console realtime info](../assets/setup/coder-for-docker-console.png) + +## Dev URLs + +To use a dev URL, set an environment variable when issuing the `docker run` +command to start your deployment (be sure to replace the placeholder URL): + +```console +DEVURL_HOST="*.mycompany.com" +``` + +For example: + +```console +docker run --rm -it -p 7080:7080 -v /var/run/docker.sock:/var/run/docker.sock -v ~/.coder:/var/run/coder codercom/coder:1.25.0 -e DEVURL_HOST="*.mycompany.com" +``` + +## Scaling + +Coder for Docker is limited by the resources of the machine on which it runs. We +recommend using Kubernetes or AWS EC2 providers if you would like automatic +multi-machine scaling. + +For organizations, we recommend one Docker host per team of 5-10 developers. + +## Known issues + +Currently, Coder for Docker does not support: + +- External PostgreSQL databases +- The use of your own TLS certificates. If you'd like to use TLS with Coder for + Docker, you'll need to run Coder behind a reverse proxy (e.g., Caddy or NGINX) + and terminate TLS at that point. diff --git a/manifest.json b/manifest.json index 25a67490f..9e1ef146a 100644 --- a/manifest.json +++ b/manifest.json @@ -167,14 +167,6 @@ { "path": "./setup/configuration.md" }, - { - "path": "./setup/updating/index.md", - "children": [ - { - "path": "./setup/updating/considerations.md" - } - ] - }, { "path": "./setup/air-gapped/index.md", "children": [ @@ -185,6 +177,14 @@ } ] }, + { + "path": "./upgrade/index.md", + "children": [ + { + "path": "./upgrade/considerations.md" + } + ] + }, { "path": "./admin/index.md", "children": [ diff --git a/setup/updating/considerations.md b/upgrade/considerations.md similarity index 100% rename from setup/updating/considerations.md rename to upgrade/considerations.md diff --git a/setup/updating/index.md b/upgrade/index.md similarity index 100% rename from setup/updating/index.md rename to upgrade/index.md From b43956dced267ae7c99b37d7606491d418d2d796 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Mon, 6 Dec 2021 10:40:41 -0600 Subject: [PATCH 5/7] restore Coder for Docker --- manifest.json | 6 +++--- {guides/deployments => setup}/docker.md | 0 2 files changed, 3 insertions(+), 3 deletions(-) rename {guides/deployments => setup}/docker.md (100%) diff --git a/manifest.json b/manifest.json index 9e1ef146a..9abf269bb 100644 --- a/manifest.json +++ b/manifest.json @@ -174,6 +174,9 @@ "path": "./setup/air-gapped/infrastructure.md" } ] + }, + { + "path": "./setup/docker.md" } ] }, @@ -406,9 +409,6 @@ { "path": "./guides/deployments/index.md", "children": [ - { - "path": "./guides/deployments/docker.md" - }, { "path": "./guides/deployments/archive-install.md" }, diff --git a/guides/deployments/docker.md b/setup/docker.md similarity index 100% rename from guides/deployments/docker.md rename to setup/docker.md From b4f3f69d70aa820455159a29a01b51f0125845c1 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Mon, 6 Dec 2021 15:34:18 -0600 Subject: [PATCH 6/7] Move upgrade --- manifest.json | 14 +++++++------- {upgrade => setup/upgrade}/considerations.md | 0 {upgrade => setup/upgrade}/index.md | 4 ++-- 3 files changed, 9 insertions(+), 9 deletions(-) rename {upgrade => setup/upgrade}/considerations.md (100%) rename {upgrade => setup/upgrade}/index.md (99%) diff --git a/manifest.json b/manifest.json index 9abf269bb..f7fb1c0d5 100644 --- a/manifest.json +++ b/manifest.json @@ -177,14 +177,14 @@ }, { "path": "./setup/docker.md" - } - ] - }, - { - "path": "./upgrade/index.md", - "children": [ + }, { - "path": "./upgrade/considerations.md" + "path": "./upgrade/index.md", + "children": [ + { + "path": "./upgrade/considerations.md" + } + ] } ] }, diff --git a/upgrade/considerations.md b/setup/upgrade/considerations.md similarity index 100% rename from upgrade/considerations.md rename to setup/upgrade/considerations.md diff --git a/upgrade/index.md b/setup/upgrade/index.md similarity index 99% rename from upgrade/index.md rename to setup/upgrade/index.md index 4b9ec9ec4..47673a826 100644 --- a/upgrade/index.md +++ b/setup/upgrade/index.md @@ -1,6 +1,6 @@ --- -title: "Updating" -description: Learn how to update your Coder deployment. +title: "Upgrade" +description: Learn how to upgrade your Coder deployment. --- This guide will show you how to update your Coder deployment. From 4c2c2b5bce16cbb6c2af5956c9920383e25422e3 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Tue, 7 Dec 2021 10:30:15 -0600 Subject: [PATCH 7/7] fix links --- manifest.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/manifest.json b/manifest.json index f7fb1c0d5..d2965e802 100644 --- a/manifest.json +++ b/manifest.json @@ -179,10 +179,10 @@ "path": "./setup/docker.md" }, { - "path": "./upgrade/index.md", + "path": "./setup/upgrade/index.md", "children": [ { - "path": "./upgrade/considerations.md" + "path": "./setup/upgrade/considerations.md" } ] }