From d4838a24be396c44bf2a8c0374c8b2038ad37231 Mon Sep 17 00:00:00 2001 From: EdwardAngert Date: Tue, 28 Jan 2025 19:10:26 +0000 Subject: [PATCH 1/5] add coder-preview doc --- docs/install/coder-preview-docker.md | 54 ++++++++++++++++++++++++++++ docs/manifest.json | 6 ++++ 2 files changed, 60 insertions(+) create mode 100644 docs/install/coder-preview-docker.md diff --git a/docs/install/coder-preview-docker.md b/docs/install/coder-preview-docker.md new file mode 100644 index 0000000000000..bf76cc9a956b8 --- /dev/null +++ b/docs/install/coder-preview-docker.md @@ -0,0 +1,54 @@ +# Install and test coder-preview + +Use Docker to install and test a +[preview release of Coder](https://github.com/coder/coder/pkgs/container/coder-preview). + +These steps are not intended for use in production deployments. +If you want to install the latest version of Coder, use the [quickstart guide](../tutorials/quickstart.md). + +1. Install Docker: + + ```bash + curl -sSL https://get.docker.com | sh + ``` + + For more details, visit: + + - [Linux instructions](https://docs.docker.com/desktop/install/linux-install/) + - [Mac instructions](https://docs.docker.com/desktop/install/mac-install/) + +1. Assign your user to the Docker group: + + ```shell + sudo usermod -aG docker $USER + ``` + +1. Run `newgrp` to activate the groups changes: + + ```shell + newgrp docker + ``` + + You might need to log out and back in or restart the machine for changes to take effect. + +1. Install Coder via `docker run` with latest preview from [coder-preview](https://github.com/coder/coder/pkgs/container/coder-preview): + + 1. ```shell + export CODER_DATA=$HOME/.config/coderv2-docker + ``` + + 1. ```shell + export DOCKER_GROUP=$(getent group docker | cut -d: -f3) + ``` + + 1. ```shell + mkdir -p $CODER_DATA + ``` + + 1. ```shell + docker run --rm -it \ + -v $CODER_DATA:/home/coder/.config \ + -v /var/run/docker.sock:/var/run/docker.sock \ + --group-add $DOCKER_GROUP \ + ghcr.io/coder/coder-preview:pr16309 + ``` diff --git a/docs/manifest.json b/docs/manifest.json index 7cf556984ecbf..db6e0b8a4f819 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -96,6 +96,12 @@ "path": "./install/uninstall.md", "icon_path": "./images/icons/trash.svg" }, + { + "title": "Install and test coder-preview", + "description": "Test the latest coder-preview build", + "path": "./install/coder-preview-docker.md", + "icon_path": "./images/icons/contributing.svg" + }, { "title": "Releases", "description": "Learn about the Coder release channels and schedule", From ba9529bd7f238c57a85d54817adfe004db9b5301 Mon Sep 17 00:00:00 2001 From: EdwardAngert Date: Tue, 28 Jan 2025 19:11:51 +0000 Subject: [PATCH 2/5] specify linux and mac --- docs/install/coder-preview-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install/coder-preview-docker.md b/docs/install/coder-preview-docker.md index bf76cc9a956b8..de913e5bafde1 100644 --- a/docs/install/coder-preview-docker.md +++ b/docs/install/coder-preview-docker.md @@ -1,7 +1,7 @@ # Install and test coder-preview Use Docker to install and test a -[preview release of Coder](https://github.com/coder/coder/pkgs/container/coder-preview). +[preview release of Coder](https://github.com/coder/coder/pkgs/container/coder-preview) using Docker on Linux or Mac. These steps are not intended for use in production deployments. If you want to install the latest version of Coder, use the [quickstart guide](../tutorials/quickstart.md). From 0d243a37820576191bb8f4cb317305d666496e28 Mon Sep 17 00:00:00 2001 From: EdwardAngert Date: Tue, 28 Jan 2025 19:15:47 +0000 Subject: [PATCH 3/5] clarify latest preview url --- docs/install/coder-preview-docker.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/install/coder-preview-docker.md b/docs/install/coder-preview-docker.md index de913e5bafde1..61a068047f5fc 100644 --- a/docs/install/coder-preview-docker.md +++ b/docs/install/coder-preview-docker.md @@ -31,7 +31,10 @@ If you want to install the latest version of Coder, use the [quickstart guide](. You might need to log out and back in or restart the machine for changes to take effect. -1. Install Coder via `docker run` with latest preview from [coder-preview](https://github.com/coder/coder/pkgs/container/coder-preview): +1. Install Coder via `docker run` with latest preview from + [coder-preview](https://github.com/coder/coder/pkgs/container/coder-preview). + Replace the `ghcr.io/coder/coder-preview:latest` in the URL of the `docker run` + step with the URL for the latest coder-preview package: 1. ```shell export CODER_DATA=$HOME/.config/coderv2-docker @@ -50,5 +53,5 @@ If you want to install the latest version of Coder, use the [quickstart guide](. -v $CODER_DATA:/home/coder/.config \ -v /var/run/docker.sock:/var/run/docker.sock \ --group-add $DOCKER_GROUP \ - ghcr.io/coder/coder-preview:pr16309 + ghcr.io/coder/coder-preview:latest ``` From a0b63f5ed39dc656ee9bcd87b8a36a4f0026ab40 Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Mon, 17 Feb 2025 11:16:02 +0000 Subject: [PATCH 4/5] Move preview installation to Docker section - Consolidates preview release installation guidance under the Docker section. - Removes the standalone page for coder-preview installation. --- docs/install/docker.md | 20 +++++++++++++++----- docs/manifest.json | 6 ------ 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/docs/install/docker.md b/docs/install/docker.md index 61da25d99e296..92e22346815e4 100644 --- a/docs/install/docker.md +++ b/docs/install/docker.md @@ -56,27 +56,37 @@ which includes an PostgreSQL container and volume. 1. Make sure you have [Docker Compose](https://docs.docker.com/compose/install/) installed. -2. Download the +1. Download the [`docker-compose.yaml`](https://github.com/coder/coder/blob/main/docker-compose.yaml) file. -3. Update `group_add:` in `docker-compose.yaml` with the `gid` of `docker` +1. Update `group_add:` in `docker-compose.yaml` with the `gid` of `docker` group. You can get the `docker` group `gid` by running the below command: ```shell getent group docker | cut -d: -f3 ``` -4. Start Coder with `docker compose up` +1. Start Coder with `docker compose up` -5. Visit the web UI via the configured url. +1. Visit the web UI via the configured url. -6. Follow the on-screen instructions log in and create your first template and +1. Follow the on-screen instructions log in and create your first template and workspace Coder configuration is defined via environment variables. Learn more about Coder's [configuration options](../admin/setup/index.md). +## Install the preview release + +
+ +You can install and test a [preview release of Coder](https://github.com/coder/coder/pkgs/container/coder-preview) by using the `ghcr.io/coder/coder-preview:latest` image tag. This image gets updated with the latest changes from the `main` branch. + +
+ +_We do not recommend using preview releases in production environments._ + ## Troubleshooting ### Docker-based workspace is stuck in "Connecting..." diff --git a/docs/manifest.json b/docs/manifest.json index 47c61c182598f..3b49c2321ccef 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -96,12 +96,6 @@ "path": "./install/uninstall.md", "icon_path": "./images/icons/trash.svg" }, - { - "title": "Install and test coder-preview", - "description": "Test the latest coder-preview build", - "path": "./install/coder-preview-docker.md", - "icon_path": "./images/icons/contributing.svg" - }, { "title": "Releases", "description": "Learn about the Coder release channels and schedule", From 21b528c93399a757ffd05ca3176810d10dfb310d Mon Sep 17 00:00:00 2001 From: M Atif Ali Date: Mon, 17 Feb 2025 17:31:07 +0500 Subject: [PATCH 5/5] Delete docs/install/coder-preview-docker.md --- docs/install/coder-preview-docker.md | 57 ---------------------------- 1 file changed, 57 deletions(-) delete mode 100644 docs/install/coder-preview-docker.md diff --git a/docs/install/coder-preview-docker.md b/docs/install/coder-preview-docker.md deleted file mode 100644 index 61a068047f5fc..0000000000000 --- a/docs/install/coder-preview-docker.md +++ /dev/null @@ -1,57 +0,0 @@ -# Install and test coder-preview - -Use Docker to install and test a -[preview release of Coder](https://github.com/coder/coder/pkgs/container/coder-preview) using Docker on Linux or Mac. - -These steps are not intended for use in production deployments. -If you want to install the latest version of Coder, use the [quickstart guide](../tutorials/quickstart.md). - -1. Install Docker: - - ```bash - curl -sSL https://get.docker.com | sh - ``` - - For more details, visit: - - - [Linux instructions](https://docs.docker.com/desktop/install/linux-install/) - - [Mac instructions](https://docs.docker.com/desktop/install/mac-install/) - -1. Assign your user to the Docker group: - - ```shell - sudo usermod -aG docker $USER - ``` - -1. Run `newgrp` to activate the groups changes: - - ```shell - newgrp docker - ``` - - You might need to log out and back in or restart the machine for changes to take effect. - -1. Install Coder via `docker run` with latest preview from - [coder-preview](https://github.com/coder/coder/pkgs/container/coder-preview). - Replace the `ghcr.io/coder/coder-preview:latest` in the URL of the `docker run` - step with the URL for the latest coder-preview package: - - 1. ```shell - export CODER_DATA=$HOME/.config/coderv2-docker - ``` - - 1. ```shell - export DOCKER_GROUP=$(getent group docker | cut -d: -f3) - ``` - - 1. ```shell - mkdir -p $CODER_DATA - ``` - - 1. ```shell - docker run --rm -it \ - -v $CODER_DATA:/home/coder/.config \ - -v /var/run/docker.sock:/var/run/docker.sock \ - --group-add $DOCKER_GROUP \ - ghcr.io/coder/coder-preview:latest - ```