diff --git a/docs/images/install/ec2.svg b/docs/images/install/ec2.svg new file mode 100644 index 0000000000..dd4a1c79c6 --- /dev/null +++ b/docs/images/install/ec2.svg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/images/install/eks.svg b/docs/images/install/eks.svg new file mode 100644 index 0000000000..adf8431151 --- /dev/null +++ b/docs/images/install/eks.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/images/install/fly.io.svg b/docs/images/install/fly.io.svg new file mode 100644 index 0000000000..0d0086b7ef --- /dev/null +++ b/docs/images/install/fly.io.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/images/install/gce.svg b/docs/images/install/gce.svg new file mode 100644 index 0000000000..158615625c --- /dev/null +++ b/docs/images/install/gce.svg @@ -0,0 +1,14 @@ + + + + + + + + + + diff --git a/docs/images/install/heroku.svg b/docs/images/install/heroku.svg new file mode 100644 index 0000000000..a332e240ae --- /dev/null +++ b/docs/images/install/heroku.svg @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/docs/images/install/railway.svg b/docs/images/install/railway.svg new file mode 100644 index 0000000000..b372817de5 --- /dev/null +++ b/docs/images/install/railway.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/images/install/render.png b/docs/images/install/render.png new file mode 100644 index 0000000000..1e73c424ae Binary files /dev/null and b/docs/images/install/render.png differ diff --git a/docs/install/1-click.md b/docs/install/1-click.md new file mode 100644 index 0000000000..2d9e7d70d8 --- /dev/null +++ b/docs/install/1-click.md @@ -0,0 +1,12 @@ +Coder can be installed on many cloud providers using our +[one-click install packages](https://github.com/coder/packages) + +| Logo | Platform Name | Status | Documentation | Deploy | +| -------------------------------------------------------- | --------------------- | ----------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| ![AWS EC2 Logo](../images/install/ec2.svg) | AWS EC2 | Live ✅ | [Guide: AWS](https://coder.com/docs/v2/latest/platforms/aws) | [Deploy from AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-5gxjyur2vc7rg?sr=0-2&ref_=beagle&applicationId=AWSMPContessa) | +| ![AWS EKS Logo](../images/install/eks.svg) | AWS EKS | In progress | [Docs: Coder on Kubernetes](https://coder.com/docs/v2/latest/install/kubernetes) | [Deploy from AWS Marketplace](https://example.com) | +| ![Google Compute Engine logo](../images/install/gce.svg) | Google Compute Engine | Live ✅ | [Guide: Google Compute Engine](https://coder.com/docs/v2/latest/platforms/gcp) | [Deploy from GCP Marketplace](https://console.cloud.google.com/marketplace/product/coder-enterprise-market-public/coder-v2) | +| ![Fly.io Logo](../images/install/fly.io.svg) | Fly.io | Live ✅ | [Blog: Run Coder on Fly.io](https://coder.com/blog/remote-developer-environments-on-fly-io) | [Deploy Coder on FLy.io](https://coder.com/blog/remote-developer-environments-on-fly-io) | +| ![Railway.app Logo](../images/install/railway.svg) | Railway.app | Live ✅ | [Blog: Run Coder on Railway.app](https://coder.com/blog/deploy-coder-on-railway-app) | [![Deploy Coder on Railway](https://railway.app/button.svg)](https://railway.app/template/coder?referralCode=tfH8Uw) | +| ![Heroku Logo](../images/install/heroku.svg) | Heroku | Live ✅ | [Docs: Deploy Coder on Heroku](./heroku/README.md) | [![Deploy Coder on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/coder/packages) | +| ![Render.com Logo](../images/install/render.png) | Render | Live ✅ | [Docs: Deploy Coder on Render](./render/README.md) | [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/coder/packages) | diff --git a/docs/install/binary.md b/docs/install/binary.md deleted file mode 100644 index 8e64681694..0000000000 --- a/docs/install/binary.md +++ /dev/null @@ -1,40 +0,0 @@ -Coder publishes self-contained .zip and .tar.gz archives in -[GitHub releases](https://github.com/coder/coder/releases/latest). The archives -bundle `coder` binary. - -1. Download the - [release archive](https://github.com/coder/coder/releases/latest) appropriate - for your operating system - -1. Unzip the folder you just downloaded, and move the `coder` executable to a - location that's on your `PATH` - - ```console - # ex. macOS and Linux - mv coder /usr/local/bin - ``` - - > Windows users: see - > [this guide](https://answers.microsoft.com/en-us/windows/forum/all/adding-path-variable/97300613-20cb-4d85-8d0e-cc9d3549ba23) - > for adding folders to `PATH`. - -1. Start a Coder server - - ```console - # Automatically sets up an external access URL on *.try.coder.app - coder server - - # Requires a PostgreSQL instance (version 13 or higher) and external access URL - coder server --postgres-url --access-url - ``` - - > Set `CODER_ACCESS_URL` to the external URL that users and workspaces will - > use to connect to Coder. This is not required if you are using the tunnel. - > Learn more about Coder's [configuration options](../admin/configure.md). - -1. Visit the Coder URL in the logs to set up your first account, or use the CLI. - -## Next steps - -- [Configuring Coder](../admin/configure.md) -- [Templates](../templates/index.md) diff --git a/docs/install/database.md b/docs/install/database.md index 482ff22320..67c7b19ef4 100644 --- a/docs/install/database.md +++ b/docs/install/database.md @@ -24,7 +24,7 @@ Coder configuration is defined via [environment variables](../admin/configure.md). The database client requires the connection string provided via the `CODER_PG_CONNECTION_URL` variable. -```console +```shell export CODER_PG_CONNECTION_URL="postgres://coder:secret42@localhost/coder?sslmode=disable" ``` @@ -53,7 +53,7 @@ Once the schema is created, you can list all schemas with `\dn`: In this case the database client requires the modified connection string: -```console +```shell export CODER_PG_CONNECTION_URL="postgres://coder:secret42@localhost/coder?sslmode=disable&search_path=myschema" ``` @@ -85,7 +85,7 @@ Please make sure that the schema selected in the connection string `...&search_path=myschema` exists and the role has granted permissions to access it. The schema should be present on this listing: -```console +```shell psql -U coder -c '\dn' ``` diff --git a/docs/install/docker.md b/docs/install/docker.md index 80ea2cfa39..818d2df3cd 100644 --- a/docs/install/docker.md +++ b/docs/install/docker.md @@ -1,16 +1,6 @@ You can install and run Coder using the official Docker images published on [GitHub Container Registry](https://github.com/coder/coder/pkgs/container/coder). -
-**Before you install** -If you would like your workspaces to be able to run Docker, we recommend that you install Sysbox before proceeding. - -As part of the Sysbox installation you will be required to remove all existing -Docker containers including containers used by Coder workspaces. Installing -Sysbox ahead of time will reduce disruption to your Coder instance. - -
- ## Requirements Docker is required. See the @@ -24,7 +14,7 @@ Docker is required. See the For proof-of-concept deployments, you can run a complete Coder instance with the following command. -```console +```shell export CODER_DATA=$HOME/.config/coderv2-docker export DOCKER_GROUP=$(getent group docker | cut -d: -f3) mkdir -p $CODER_DATA @@ -43,13 +33,15 @@ systems `/var/run/docker.sock` is not group writeable or does not belong to the Coder configuration is defined via environment variables. 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 (version 13 or higher). Set `ACCESS_URL` to the external URL that users and workspaces will use to connect to Coder. -```console +```shell docker run --rm -it \ -e CODER_ACCESS_URL="https://coder.example.com" \ -e CODER_PG_CONNECTION_URL="postgresql://username:password@database/coder" \ @@ -70,7 +62,7 @@ which includes an PostgreSQL container and volume. 2. Clone the `coder` repository: - ```console + ```shell git clone https://github.com/coder/coder.git ``` @@ -82,19 +74,19 @@ which includes an PostgreSQL container and volume. For proof-of-concept deployments, you can use [Coder's tunnel](../admin/configure.md#tunnel): - ```console + ```shell cd coder - docker-compose up + docker compose up ``` For production deployments, we recommend setting an [access URL](../admin/configure.md#access-url): - ```console + ```shell cd coder - CODER_ACCESS_URL=https://coder.example.com docker-compose up + CODER_ACCESS_URL=https://coder.example.com docker compose up ``` 4. Visit the web ui via the configured url. You can add `/login` to the base url @@ -103,6 +95,8 @@ which includes an PostgreSQL container and volume. 5. Follow the on-screen instructions log in and create your first template and workspace +
+ ## Troubleshooting ### Docker-based workspace is stuck in "Connecting..." diff --git a/docs/install/index.md b/docs/install/index.md index b08bfdaab7..88c3ea2d23 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -1,5 +1,249 @@ -There are a number of different methods to install and run Coder: +To use Coder you will need to install the Coder server on your infrastructure. +There are a number of different ways to install Coder, depending on your needs. - This page is rendered on https://coder.com/docs/coder-oss/latest/install. Refer to the other documents in the `install/` directory for per-platform instructions. + This page is rendered on https://coder.com/docs/v2/latest/install. Refer to the other documents in the `install/` directory for per-platform instructions. + +## Install Coder + +
+ +## Linux + +
+ +## Install Script + +The easiest way to install Coder on Linux is to use our +[install script](https://github.com/coder/coder/blob/main/install.sh). + +```shell +curl -fsSL https://coder.com/install.sh | sh +``` + +You can preview what occurs during the install process: + +```shell +curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run +``` + +You can modify the installation process by including flags. Run the help command +for reference: + +```shell +curl -fsSL https://coder.com/install.sh | sh -s -- --help +``` + +## Homebrew + +To install Coder on Linux, you can use the [Homebrew](https://brew.sh/) package +manager that uses our official [Homebrew tap](github.com/coder/homebrew-coder). + +```shell +brew install coder/coder/coder +``` + +## System Packages + +Coder officially maintains packages for the following Linux distributions: + +- .deb (Debian, Ubuntu) +- .rpm (Fedora, CentOS, RHEL, SUSE) +- .apk (Alpine) + +
+ +## Debian, Ubuntu + +For Debian and Ubuntu, get the latest `.deb` package from our +[GitHub releases](https://github.com/coder/coder/releases/latest) and install it +manually or use the following commands to download and install the latest `.deb` +package. + +```shell +# Install the package +sudo apt install ./coder.deb +``` + +## RPM Linux + +For Fedora, CentOS, RHEL, SUSE, get the latest `.rpm` package from our +[GitHub releases](https://github.com/coder/coder/releases/latest) and install it +manually or use the following commands to download and install the latest `.rpm` +package. + +```shell +# Install the package +sudo yum install ./coder.rpm +``` + +## Alpine + +Get the latest `.apk` package from our +[GitHub releases](https://github.com/coder/coder/releases/latest) and install it +manually or use the following commands to download and install the latest `.apk` +package. + +```shell +# Install the package +sudo apk add ./coder.apk +``` + +
+ +## Manual + +Get the latest `.tar.gz` package from our GitHub releases page and install it +manually. + +1. Download the + [release archive](https://github.com/coder/coder/releases/latest) appropriate + for your operating system + +2. Unzip the folder you just downloaded, and move the `coder` executable to a + location that's on your `PATH` + +```shell +mv coder /usr/local/bin +``` + +
+ +## macOS + +
+ +## Homebrew + +To install Coder on macOS, you can use the [Homebrew](https://brew.sh/) package +manager that uses our official +[Homebrew tap](https://github.com/coder/homebrew-coder). + +```shell +brew install coder/coder/coder +``` + +## Install Script + +The easiest way to install Coder on macOS is to use our +[install script](https://github.com/coder/coder/blob/main/install.sh). + +```shell +curl -fsSL https://coder.com/install.sh | sh +``` + +You can preview what occurs during the install process: + +```shell +curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run +``` + +You can modify the installation process by including flags. Run the help command +for reference: + +```shell +curl -fsSL https://coder.com/install.sh | sh -s -- --help +``` + +
+ +## Windows + +
+ +## Winget + +To install Coder on Windows, you can use the +[`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget) +package manager. + +```powershell +winget install Coder.Coder +``` + +## Installer + +Download the Windows installer from our +[GitHub releases](https://github.com/coder/coder/releases/latest) and install +it. + +## Manual + +Get the latest `.zip` package from our GitHub releases page and extract it to a +location that's on your `PATH` or add the extracted binary to your `PATH`. + +> Windows users: see +> [this guide](https://answers.microsoft.com/en-us/windows/forum/all/adding-path-variable/97300613-20cb-4d85-8d0e-cc9d3549ba23) +> for adding folders to `PATH`. + +
+ +
+ +## Verify installation + +Verify that the installation was successful by opening a new terminal and +running: + +```console +coder --version +Coder v2.6.0+b3e3521 Thu Dec 21 22:33:13 UTC 2023 +https://github.com/coder/coder/commit/b3e352127478bfd044a1efa77baace096096d1e6 + +Full build of Coder, supports the server subcommand. +... +``` + +## Start Coder + +1. After installing, start the Coder server manually via `coder server` or as a + system package. + +
+ + ## Terminal + + ```shell + # Automatically sets up an external access URL on *.try.coder.app + coder server + + # Requires a PostgreSQL instance (version 13 or higher) and external access URL + coder server --postgres-url --access-url + ``` + + ## System Package (Linux) + + Run Coder as a system service. + + ```shell + # (Optional) Set up an access URL + sudo vim /etc/coder.d/coder.env + + # To systemd to start Coder now and on reboot + sudo systemctl enable --now coder + + # View the logs to see Coder URL and ensure a successful start + journalctl -u coder.service -b + ``` + +
+ + > Set `CODER_ACCESS_URL` to the external URL that users and workspaces will + > use to connect to Coder. This is not required if you are using the tunnel. + > Learn more about Coder's [configuration options](../admin/configure.md). + + By default, the Coder server runs on `http://127.0.0.1:3000` and uses a + [public tunnel](../admin/configure.md#tunnel) for workspace connections. + +2. Visit the Coder URL in the logs to set up your first account, or use the CLI + to create your first user. + + ```shell + coder login + ``` + +## Next steps + +- [Configuring Coder](../admin/configure.md) +- [Templates](../templates/index.md) diff --git a/docs/install/install.sh.md b/docs/install/install.sh.md deleted file mode 100644 index ab23cec573..0000000000 --- a/docs/install/install.sh.md +++ /dev/null @@ -1,114 +0,0 @@ -The easiest way to install Coder is to use our -[install script](https://github.com/coder/coder/blob/main/install.sh) for Linux -and macOS. - -To install, run: - -```bash -curl -fsSL https://coder.com/install.sh | sh -``` - -You can preview what occurs during the install process: - -```bash -curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run -``` - -You can modify the installation process by including flags. Run the help command -for reference: - -```bash -curl -fsSL https://coder.com/install.sh | sh -s -- --help -``` - -After installing, use the in-terminal instructions to start the Coder server -manually via `coder server` or as a system package. - -By default, the Coder server runs on `http://127.0.0.1:3000` and uses a -[public tunnel](../admin/configure.md#tunnel) for workspace connections. - -## PATH conflicts - -It's possible to end up in situations where you have multiple `coder` binaries -in your `PATH`, and your system may use a version that you don't intend. Your -`PATH` is a variable that tells your shell where to look for programs to run. - -You can check where all of the versions are by running `which -a coder`. - -For example, a common conflict on macOS might be between a version installed by -Homebrew, and a version installed manually to the /usr/local/bin directory. - -```console -$ which -a coder -/usr/local/bin/coder -/opt/homebrew/bin/coder -``` - -Whichever binary comes first in this list will be used when running `coder` -commands. - -### Reordering your PATH - -If you use bash or zsh, you can update your `PATH` like this: - -```shell -# You might want to add this line to the end of your ~/.bashrc or ~/.zshrc file! -export PATH="/opt/homebrew/bin:$PATH" -``` - -If you use fish, you can update your `PATH` like this: - -```shell -# You might want to add this line to the end of your ~/.config/fish/config.fish file! -fish_add_path "/opt/homebrew/bin" -``` - -> ℹ If you ran install.sh with a `--prefix` flag, you can replace -> `/opt/homebrew` with whatever value you used there. Make sure to leave the -> `/bin` at the end! - -Now we can observe that the order has changed: - -```console -$ which -a coder -/opt/homebrew/bin/coder -/usr/local/bin/coder -``` - -### Removing unneeded binaries - -If you want to uninstall a version of `coder` that you installed with a package -manager, you can run whichever one of these commands applies: - -```shell -# On macOS, with Homebrew installed -brew uninstall coder -``` - -```shell -# On Debian/Ubuntu based systems -sudo dpkg -r coder -``` - -```shell -# On Fedora/RHEL-like systems -sudo rpm -e coder -``` - -```shell -# On Alpine -sudo apk del coder -``` - -If the conflicting binary is not installed by your system package manager, you -can just delete it. - -```shell -# You might not need `sudo`, depending on the location -sudo rm /usr/local/bin/coder -``` - -## Next steps - -- [Configuring Coder](../admin/configure.md) -- [Templates](../templates/index.md) diff --git a/docs/install/kubernetes.md b/docs/install/kubernetes.md index 9782a49742..4458ae17b7 100644 --- a/docs/install/kubernetes.md +++ b/docs/install/kubernetes.md @@ -46,7 +46,7 @@ locally in order to log in and manage templates. The cluster-internal DB URL for the above database is: - ```console + ```shell postgres://coder:coder@coder-db-postgresql.coder.svc.cluster.local:5432/coder?sslmode=disable ``` @@ -57,7 +57,7 @@ locally in order to log in and manage templates. 1. Create a secret with the database URL: - ```console + ```shell # Uses Bitnami PostgreSQL example. If you have another database, # change to the proper URL. kubectl create secret generic coder-db-url -n coder \ @@ -66,7 +66,7 @@ locally in order to log in and manage templates. 1. Add the Coder Helm repo: - ```console + ```shell helm repo add coder-v2 https://helm.coder.com/v2 ``` @@ -112,7 +112,7 @@ locally in order to log in and manage templates. 1. Run the following command to install the chart in your cluster. - ```console + ```shell helm install coder coder-v2/coder \ --namespace coder \ --values values.yaml @@ -135,7 +135,7 @@ locally in order to log in and manage templates. To upgrade Coder in the future or change values, you can run the following command: -```console +```shell helm repo update helm upgrade coder coder-v2/coder \ --namespace coder \ @@ -201,8 +201,8 @@ follow the steps below: 1. Create the certificate as a secret in your Kubernetes cluster, if not already present: -```console -$ kubectl create secret tls postgres-certs -n coder --key="postgres.key" --cert="postgres.crt" +```shell +kubectl create secret tls postgres-certs -n coder --key="postgres.key" --cert="postgres.crt" ``` 1. Define the secret volume and volumeMounts in the Helm chart: @@ -221,7 +221,7 @@ coder: 1. Lastly, your PG connection URL will look like: -```console +```shell postgres://:@databasehost:/?sslmode=require&sslcert=$HOME/.postgresql/postgres.crt&sslkey=$HOME/.postgresql/postgres.key" ``` diff --git a/docs/install/macos.md b/docs/install/macos.md deleted file mode 100644 index 18b9f0b326..0000000000 --- a/docs/install/macos.md +++ /dev/null @@ -1,35 +0,0 @@ -# macOS - -You can use [Homebrew](https://brew.sh) to install the `coder` command. Homebrew -is recommended, but you can also use our [install script](./install.sh.md) or -download a [standalone binary](./binary.md). - -1. Install Coder from our official - [Homebrew tap](https://github.com/coder/homebrew-coder) - - ```console - brew install coder/coder/coder - ``` - - ![Homebrew output from installing Coder](../images/install/homebrew.png) - -2. Start a Coder server - - ```console - # Automatically sets up an external access URL on *.try.coder.app - coder server - - # Requires a PostgreSQL instance (version 13 or higher) and external access URL - coder server --postgres-url --access-url - ``` - - > Set `CODER_ACCESS_URL` to the external URL that users and workspaces will - > use to connect to Coder. This is not required if you are using the tunnel. - > Learn more about Coder's [configuration options](../admin/configure.md). - -3. Visit the Coder URL in the logs to set up your first account, or use the CLI. - -## Next steps - -- [Configuring Coder](../admin/configure.md) -- [Templates](../templates/index.md) diff --git a/docs/install/openshift.md b/docs/install/openshift.md index 19e122e47f..cb8bb779ea 100644 --- a/docs/install/openshift.md +++ b/docs/install/openshift.md @@ -15,13 +15,13 @@ locally in order to log in and manage templates. Run the following command to login to your OpenShift cluster: -```console +```shell oc login --token=w4r...04s --server= ``` Next, you will run the below command to create a project for Coder: -```console +```shell oc new-project coder ``` @@ -170,7 +170,7 @@ oc apply -f route.yaml You can now install Coder using the values you've set from the above steps. To do so, run the series of `helm` commands below: -```console +```shell helm repo add coder-v2 https://helm.coder.com/v2 helm repo update helm install coder coder-v2/coder \ @@ -245,7 +245,7 @@ Security Context Constraints (SCCs) in OpenShift. > For more information, please consult the > [OpenShift Documentation](https://docs.openshift.com/container-platform/4.12/cicd/builds/understanding-buildconfigs.html). - ```console + ```shell oc create -f - < Set `CODER_ACCESS_URL` to the external URL that users and workspaces will - > use to connect to Coder. This is not required if you are using the tunnel. - > Learn more about Coder's [configuration options](../admin/configure.md). - -1. Visit the Coder URL in the logs to set up your first account, or use the CLI: - - ```console - coder login - ``` - -## Restarting Coder - -After updating Coder or applying configuration changes, restart the server: - -```console -sudo systemctl restart coder -``` - -## Next steps - -- [Configuring Coder](../admin/configure.md) -- [Templates](../templates/index.md) diff --git a/docs/install/uninstall.md b/docs/install/uninstall.md index c6c5056f1e..9c0982d5cb 100644 --- a/docs/install/uninstall.md +++ b/docs/install/uninstall.md @@ -6,40 +6,68 @@ To uninstall your Coder server, delete the following directories. ## Cached Coder releases -```console +```shell rm -rf ~/.cache/coder ``` ## The Coder server binary and CLI -Debian, Ubuntu: +
-```console +## Linux + +
+ +## Debian, Ubuntu + +```shell sudo apt remove coder ``` -Fedora, CentOS, RHEL, SUSE: +## Fedora, CentOS, RHEL, SUSE -```console +```shell sudo yum remove coder ``` -Alpine: +## Alpine -```console +```shell sudo apk del coder ``` +
+ If you installed Coder manually or used the install script on an unsupported operating system, you can remove the binary directly: -```console +```shell sudo rm /usr/local/bin/coder ``` +## macOS + +```shell +brew uninstall coder +``` + +If you installed Coder manually, you can remove the binary directly: + +```shell +sudo rm /usr/local/bin/coder +``` + +## Windows + +```powershell +winget uninstall Coder.Coder +``` + +
+ ## Coder as a system service configuration -```console +```shell sudo rm /etc/coder.d/coder.env ``` @@ -49,20 +77,24 @@ sudo rm /etc/coder.d/coder.env > database engine and database. If you want to reuse the database, consider not > performing the following step or copying the directory to another location. -### macOS +
-```console +## macOS + +```shell rm -rf ~/Library/Application\ Support/coderv2 ``` -### Linux +## Linux -```console +```shell rm -rf ~/.config/coderv2 ``` -### Windows +## Windows -```console -C:\Users\USER\AppData\Roaming\coderv2 +```powershell +rmdir %AppData%\coderv2 ``` + +
diff --git a/docs/install/windows.md b/docs/install/windows.md deleted file mode 100644 index d4eb53e6cf..0000000000 --- a/docs/install/windows.md +++ /dev/null @@ -1,38 +0,0 @@ -# Windows - -Use the Windows installer to download the CLI and add Coder to `PATH`. -Alternatively, you can install Coder on Windows via a -[standalone binary](./binary.md). - -1. Download the Windows installer from - [GitHub releases](https://github.com/coder/coder/releases/latest) or from - `winget` - - ```powershell - winget install Coder.Coder - ``` - -2. Run the application - - ![Windows installer](../images/install/windows-installer.png) - -3. Start a Coder server - - ```console - # Automatically sets up an external access URL on *.try.coder.app - coder server - - # Requires a PostgreSQL instance (version 13 or higher) and external access URL - coder server --postgres-url --access-url - ``` - - > Set `CODER_ACCESS_URL` to the external URL that users and workspaces will - > use to connect to Coder. This is not required if you are using the tunnel. - > Learn more about Coder's [configuration options](../admin/configure.md). - -4. Visit the Coder URL in the logs to set up your first account, or use the CLI. - -## Next steps - -- [Configuring Coder](../admin/configure.md) -- [Templates](../templates/index.md) diff --git a/docs/manifest.json b/docs/manifest.json index 2f68e6f020..4dbfc875b4 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -21,45 +21,20 @@ "path": "./install/index.md", "icon_path": "./images/icons/download.svg", "children": [ - { - "title": "Install script", - "description": "One-line install script for macOS and Linux", - "path": "./install/install.sh.md" - }, - { - "title": "System packages", - "description": "System packages for Debian, Ubuntu, Fedora, CentOS, RHEL, SUSE, and Alpine", - "path": "./install/packages.md" - }, - { - "title": "macOS", - "description": "Install Coder using our Homebrew tap", - "path": "./install/macos.md" - }, { "title": "Kubernetes", "description": "Install Coder with Kubernetes via Helm", "path": "./install/kubernetes.md" }, - { - "title": "OpenShift", - "description": "Install Coder on OpenShift", - "path": "./install/openshift.md" - }, { "title": "Docker", "description": "Install Coder with Docker / docker-compose", "path": "./install/docker.md" }, { - "title": "Windows", - "description": "Install Coder on Windows", - "path": "./install/windows.md" - }, - { - "title": "Standalone binaries", - "description": "Download binaries for macOS, Windows, and Linux", - "path": "./install/binary.md" + "title": "OpenShift", + "description": "Install Coder on OpenShift", + "path": "./install/openshift.md" }, { "title": "Offline deployments", @@ -75,6 +50,11 @@ "title": "Uninstall", "description": "Learn how to uninstall Coder", "path": "./install/uninstall.md" + }, + { + "title": "1-click install", + "description": "Install Coder on a cloud provider with a single click", + "path": "./install/1-click.md" } ] }, diff --git a/docs/platforms/docker.md b/docs/platforms/docker.md index 09e8fc7a4e..bcd633c83a 100644 --- a/docs/platforms/docker.md +++ b/docs/platforms/docker.md @@ -6,19 +6,28 @@ Coder with Docker has the following advantages: - Workspace images are easily configured - Workspaces share resources for burst operations -> Note that the below steps are only supported on a Linux distribution. If on -> macOS, please [run Coder via the standalone binary](../install//binary.md). +> Note that the below steps are only supported on a Linux distribution. ## Requirements - A Linux machine - A running Docker daemon +
+Before you install +If you would like your workspaces to be able to run Docker, we recommend that you install Sysbox before proceeding. + +As part of the Sysbox installation you will be required to remove all existing +Docker containers including containers used by Coder workspaces. Installing +Sysbox ahead of time will reduce disruption to your Coder instance. + +
+ ## Instructions 1. Run Coder with Docker. - ```console + ```shell export CODER_DATA=$HOME/.config/coderv2-docker export DOCKER_GROUP=$(getent group docker | cut -d: -f3) mkdir -p $CODER_DATA @@ -37,7 +46,7 @@ Coder with Docker has the following advantages: 1. In new terminal, [install Coder](../install/) in order to connect to your deployment through the CLI. - ```console + ```shell curl -L https://coder.com/install.sh | sh ``` @@ -47,7 +56,7 @@ Coder with Docker has the following advantages: 1. Pull the "Docker" example template using the interactive `coder templates init`: - ```console + ```shell coder templates init cd docker ``` diff --git a/docs/platforms/other.md b/docs/platforms/other.md index a01654cec0..d2f08ebd2d 100644 --- a/docs/platforms/other.md +++ b/docs/platforms/other.md @@ -8,7 +8,6 @@ workspaces can include any Terraform resource. See our The following resources may help as you're deploying Coder. - [Coder packages: one-click install on cloud providers](https://github.com/coder/packages) -- [Run Coder as a system service](../install/packages.md) - [Deploy Coder offline](../install/offline.md) - [Supported resources (Terraform registry)](https://registry.terraform.io) - [Writing custom templates](../templates/index.md)