mirror of https://github.com/coder/coder.git
chore(docs): reorganize installation docs (#11465)
This commit is contained in:
Muhammad Atif Ali
GitHub
parent
dfe8efc186
commit
9682db593e
|
|
@ -0,0 +1,8 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<svg viewBox="0 0 70 70" xml:space="preserve" xmlns="http://www.w3.org/2000/svg">
|
||||
<g fill="#F7981F">
|
||||
<path d="M30.879 61.843a3.003 3.003 0 0 0 3.002 3.002h27.436a3.003 3.003 0 0 0 3.002-3.002V33.738a3.002 3.002 0 0 0-3.002-3.002H33.881a3.003 3.003 0 0 0-3.002 3.002v28.105z"/>
|
||||
<path d="M28.232 31.124a3.003 3.003 0 0 1 3.002-3.002H51.8v-7.145a3.002 3.002 0 0 0-3.001-3.002H21.365a3.002 3.002 0 0 0-3.002 3.002v28.104a3.002 3.002 0 0 0 3.002 3.002h6.867V31.124z"/>
|
||||
<path d="M15.87 18.427a3.002 3.002 0 0 1 3.002-3.002h20.566V8.28a3.003 3.003 0 0 0-3.002-3.002H9.002A3.002 3.002 0 0 0 6 8.28v28.105a3.003 3.003 0 0 0 3.002 3.002h6.868v-20.96z"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 727 B |
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="22.747 28.773 57.894 42.847" height="64" width="64"><defs><clipPath id="A"><path d="M525.438 782.113h33.964V681.938l97.8 100.175h44.836l-107.312-110.37 114.097-127.355H665.36l-105.957 118.86v-118.86H525.44z"/></clipPath><linearGradient id="B" spreadMethod="pad" gradientUnits="userSpaceOnUse" y2="790.912" x2="536.264" y1="550.499" x1="682.17"><stop offset="0" stop-color="#4f66b9"/><stop offset="1" stop-color="#484fab"/></linearGradient><clipPath id="C"><path d="M631.824 876.457l167.266-96.57a9.24 9.24 0 0 0 4.609-7.989V578.754c0-3.293 1.77-6.34 4.62-7.988l149.266-86.184c6.152-3.555 13.84.9 13.84 7.988v376.172c0 3.293-1.758 6.336-4.6 7.988l-325.76 188.08c-6.153 3.55-13.852-.9-13.852-8V884.445c0-3.3 1.762-6.336 4.62-7.988z"/></clipPath><linearGradient id="D" spreadMethod="pad" gradientUnits="userSpaceOnUse" y2="1086.135" x2="677.091" y1="516.667" x1="1007.83"><stop offset="0" stop-color="#4f66b9"/><stop offset="1" stop-color="#484fab"/></linearGradient><clipPath id="E"><path d="M775.75 530.344l-167.266-96.57c-2.85-1.652-6.375-1.652-9.226 0L408.652 543.82a9.26 9.26 0 0 0-4.62 8v220.097a9.25 9.25 0 0 0 4.621 7.989L575.92 876.47a9.22 9.22 0 0 1 4.617 7.984v172.367c0 7.1-7.695 11.54-13.847 8L240.926 876.73c-2.852-1.652-4.6-4.695-4.6-7.988v-413.77c0-3.3 1.758-6.336 4.6-8L599.258 240.1c2.85-1.653 6.375-1.653 9.226 0l325.762 188.074c6.152 3.554 6.152 12.433 0 15.984L784.98 530.344c-2.863 1.652-6.378 1.652-9.23 0z"/></clipPath><linearGradient id="F" spreadMethod="pad" gradientUnits="userSpaceOnUse" y2="920.709" x2="318.474" y1="284.03" x1="679.093"><stop offset="0" stop-color="#4c68bb"/><stop offset="1" stop-color="#5180c9"/></linearGradient></defs><g transform="matrix(.069988 0 0 -.069988 9.429963 95.860819)"><path d="M525.438 782.113h33.964V681.938l97.8 100.175h44.836l-107.312-110.37 114.097-127.355H665.36l-105.957 118.86v-118.86H525.44v237.726" fill="url(#B)" clip-path="url(#A)"/><path d="M631.824 876.457l167.266-96.57a9.24 9.24 0 0 0 4.609-7.989V578.754c0-3.293 1.77-6.34 4.62-7.988l149.266-86.184c6.152-3.555 13.84.9 13.84 7.988v376.172c0 3.293-1.758 6.336-4.6 7.988l-325.76 188.08c-6.153 3.55-13.852-.9-13.852-8V884.445c0-3.3 1.762-6.336 4.62-7.988" fill="url(#D)" clip-path="url(#C)"/><path d="M775.75 530.344l-167.266-96.57c-2.85-1.652-6.375-1.652-9.226 0L408.652 543.82a9.26 9.26 0 0 0-4.62 8v220.097a9.25 9.25 0 0 0 4.621 7.989L575.92 876.47a9.22 9.22 0 0 1 4.617 7.984v172.367c0 7.1-7.695 11.54-13.847 8L240.926 876.73c-2.852-1.652-4.6-4.695-4.6-7.988v-413.77c0-3.3 1.758-6.336 4.6-8L599.258 240.1c2.85-1.653 6.375-1.653 9.226 0l325.762 188.074c6.152 3.554 6.152 12.433 0 15.984L784.98 530.344c-2.863 1.652-6.378 1.652-9.23 0" fill="url(#F)" clip-path="url(#E)"/></g></svg>
|
||||
|
After Width: | Height: | Size: 2.7 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 6.5 KiB |
|
|
@ -0,0 +1,14 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- Generator: Adobe Illustrator 19.1.1, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
|
||||
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
||||
viewBox="0 0 48 48" enable-background="new 0 0 48 48" xml:space="preserve">
|
||||
<path fill="#2196F3" d="M44.2,22.7L34.7,7.2C34.3,6.5,33.4,6,32.5,6H15.4c-0.9,0-1.7,0.5-2.2,1.2L3.8,22.7c-0.5,0.8-0.5,1.9,0,2.7
|
||||
l9.4,15.4c0.5,0.8,1.3,1.2,2.2,1.2h17.1c0.9,0,1.7-0.5,2.2-1.2l9.5-15.4C44.7,24.5,44.7,23.5,44.2,22.7z"/>
|
||||
<path fill="#1976D2" d="M29,15l-2,2l-2-2l-2,2l-2-2l-2,4l-4,2l2,2l-2,2l2,2l-2,2l13,13h4.5c0.9,0,1.7-0.5,2.2-1.2l7.6-12.4L29,15z"
|
||||
/>
|
||||
<g>
|
||||
<rect x="22" y="22" fill="#FFFFFF" width="4" height="4"/>
|
||||
<path fill="#FFFFFF" d="M33,21v-2h-3v-1h-1v-3h-2v3h-2v-3h-2v3h-2v-3h-2v3h-1v1h-3v2h3v2h-3v2h3v2h-3v2h3v1h1v3h2v-3h2v3h2v-3h2v3
|
||||
h2v-3h1v-1h3v-2h-3v-2h3v-2h-3v-2H33z M20,28v-8h8v8H20z"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 967 B |
|
|
@ -0,0 +1,2 @@
|
|||
<?xml version="1.0" encoding="utf-8"?><!-- Uploaded to: SVG Repo, www.svgrepo.com, Generator: SVG Repo Mixer Tools -->
|
||||
<svg width="800px" height="800px" viewBox="-72 0 400 400" xmlns="http://www.w3.org/2000/svg" preserveAspectRatio="xMinYMin meet"><path d="M28.083 398.289V363.51c0-2.452-1.798-3.51-3.917-3.51-4.248 0-9.554 1.058-14.37 3.181v35.108H0v-64.576h9.795v21.304c4.656-1.712 10.206-3.18 15.758-3.18 8.898 0 12.246 5.469 12.246 12.976v33.476h-9.716zm27.999-21.063c.326 11.674 2.613 13.961 9.794 13.961 5.634 0 12.002-1.879 16.902-3.757l1.632 7.346c-5.226 2.37-11.593 4.655-19.183 4.655-16.33 0-18.862-8.978-18.862-23.268 0-7.835.573-14.939 2.45-21.47 4.898-1.878 11.43-2.857 19.673-2.857 13.393 0 17.473 7.43 17.473 20.41v4.98H56.082zM68.488 360c-2.935 0-7.59.082-11.427.813-.406 1.96-.899 4.655-1.062 9.636h20.41c0-6.778-1.225-10.449-7.921-10.449zm35.837 3.181v35.108h-9.797v-39.515c8.246-4.489 16.981-5.877 22.698-6.285v8.164c-4 .326-9.064.816-12.9 2.528zm38.778 36.25c-14.616 0-21.228-7.183-21.228-23.594 0-17.389 8.735-24 21.228-24 14.612 0 21.226 7.182 21.226 23.592 0 17.39-8.737 24.002-21.226 24.002zm0-39.43c-7.512 0-11.675 4.325-11.675 15.836 0 12.574 3.51 15.35 11.675 15.35 7.51 0 11.674-4.247 11.674-15.758 0-12.574-3.51-15.429-11.674-15.429zm68.49 38.288H200.08c-2.692-7.184-6.45-14.532-12.246-20.9h-5.144v20.9h-9.796v-64.576h9.796v37.062h4.573c4.98-5.144 8.816-11.509 11.511-17.797h11.02c-3.754 7.593-8.57 14.287-13.959 19.757 6.45 8.164 11.511 16.818 15.757 25.554zm18.363 1.142c-8.897 0-12.244-5.468-12.244-12.98v-33.473h9.714v34.697c0 2.452 1.794 3.512 3.917 3.512 4.246 0 10.042-1.06 14.86-3.184v-35.025H256v39.35c-11.593 6.369-20.493 7.103-26.044 7.103zM225.628 317.253H30.258C13.545 317.253 0 303.708 0 286.998V30.256C0 13.546 13.546 0 30.257 0h195.37c16.71 0 30.26 13.546 30.26 30.256v256.742c0 16.71-13.55 30.255-30.26 30.255z" fill="#6762A6"/><path d="M160.36 273.6V147.61s8.195-30.15-100.943 12.334c-.2.539-.2-116.504-.2-116.504l35.66-.22v74.991s99.846-39.325 99.846 29.824V273.6h-34.362zm20.32-184.994h-37.824c13.615-16.646 25.94-45.167 25.94-45.167h39.11s-6.696 18.587-27.225 45.167zM59.865 273.382v-71.748l35.878 35.877-35.878 35.871z" fill="#FFF"/></svg>
|
||||
|
After Width: | Height: | Size: 2.1 KiB |
|
|
@ -0,0 +1 @@
|
|||
<svg width="1024" height="1024" viewBox="0 0 1024 1024" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M4.756 438.175A520.713 520.713 0 0 0 0 489.735h777.799c-2.716-5.306-6.365-10.09-10.045-14.772-132.97-171.791-204.498-156.896-306.819-161.26-34.114-1.403-57.249-1.967-193.037-1.967-72.677 0-151.688.185-228.628.39-9.96 26.884-19.566 52.942-24.243 74.14h398.571v51.909H4.756ZM783.93 541.696H.399c.82 13.851 2.112 27.517 3.978 40.999h723.39c32.248 0 50.299-18.297 56.162-40.999ZM45.017 724.306S164.941 1018.77 511.46 1024c207.112 0 385.071-123.006 465.907-299.694H45.017Z" fill="#fff"/><path d="M511.454 0C319.953 0 153.311 105.16 65.31 260.612c68.771-.144 202.704-.226 202.704-.226h.031v-.051c158.309 0 164.193.707 195.118 1.998l19.149.706c66.7 2.224 148.683 9.384 213.19 58.19 35.015 26.471 85.571 84.896 115.708 126.52 27.861 38.499 35.876 82.756 16.933 125.158-17.436 38.97-54.952 62.215-100.383 62.215H16.69s4.233 17.944 10.58 37.751h970.632A510.385 510.385 0 0 0 1024 512.218C1024.01 229.355 794.532 0 511.454 0Z" fill="#fff"/></svg>
|
||||
|
After Width: | Height: | Size: 1.0 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.3 KiB |
|
|
@ -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 | 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 | In progress | [Docs: Coder on Kubernetes](https://coder.com/docs/v2/latest/install/kubernetes) | [Deploy from AWS Marketplace](https://example.com) |
|
||||
|  | 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 | 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 | Live ✅ | [Blog: Run Coder on Railway.app](https://coder.com/blog/deploy-coder-on-railway-app) | [](https://railway.app/template/coder?referralCode=tfH8Uw) |
|
||||
|  | Heroku | Live ✅ | [Docs: Deploy Coder on Heroku](./heroku/README.md) | [](https://heroku.com/deploy?template=https://github.com/coder/packages) |
|
||||
|  | Render | Live ✅ | [Docs: Deploy Coder on Render](./render/README.md) | [](https://render.com/deploy?repo=https://github.com/coder/packages) |
|
||||
|
|
@ -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 <url> --access-url <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)
|
||||
|
|
@ -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'
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -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).
|
||||
|
||||
<blockquote class="warning">
|
||||
**Before you install**
|
||||
If you would like your workspaces to be able to run Docker, we recommend that you <a href="https://github.com/nestybox/sysbox#installation" target="_blank">install Sysbox</a> 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.
|
||||
|
||||
</blockquote>
|
||||
|
||||
## 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).
|
||||
|
||||
<div class="tabs">
|
||||
|
||||
## 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
|
||||
|
||||
</div>
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Docker-based workspace is stuck in "Connecting..."
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
<children>
|
||||
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.
|
||||
</children>
|
||||
|
||||
## Install Coder
|
||||
|
||||
<div class="tabs">
|
||||
|
||||
## Linux
|
||||
|
||||
<div class="tabs">
|
||||
|
||||
## 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)
|
||||
|
||||
<div class="tabs">
|
||||
|
||||
## 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
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
## 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
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
## macOS
|
||||
|
||||
<div class="tabs">
|
||||
|
||||
## 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
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
## Windows
|
||||
|
||||
<div class="tabs">
|
||||
|
||||
## 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`.
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
## 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.
|
||||
|
||||
<div class="tabs">
|
||||
|
||||
## 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 <url> --access-url <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
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
> 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 <access url>
|
||||
```
|
||||
|
||||
## Next steps
|
||||
|
||||
- [Configuring Coder](../admin/configure.md)
|
||||
- [Templates](../templates/index.md)
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
@ -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://<user>:<password>@databasehost:<port>/<db-name>?sslmode=require&sslcert=$HOME/.postgresql/postgres.crt&sslkey=$HOME/.postgresql/postgres.key"
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
```
|
||||
|
||||
|
||||
|
||||
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 <url> --access-url <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)
|
||||
|
|
@ -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=<cluster-url>
|
||||
```
|
||||
|
||||
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 - <<EOF
|
||||
kind: BuildConfig
|
||||
apiVersion: build.openshift.io/v1
|
||||
|
|
@ -290,7 +290,7 @@ Security Context Constraints (SCCs) in OpenShift.
|
|||
|
||||
1. Create an `ImageStream` as a target for the previous step:
|
||||
|
||||
```console
|
||||
```shell
|
||||
oc create imagestream enterprise-base
|
||||
```
|
||||
|
||||
|
|
@ -307,7 +307,7 @@ Security Context Constraints (SCCs) in OpenShift.
|
|||
|
||||
Start from the default "Kubernetes" template:
|
||||
|
||||
```console
|
||||
```shell
|
||||
echo kubernetes | coderv2 templates init ./openshift-k8s
|
||||
cd ./openshift-k8s
|
||||
```
|
||||
|
|
@ -321,7 +321,7 @@ Edit `main.tf` and update the following fields of the Kubernetes pod resource:
|
|||
|
||||
Finally, create the template:
|
||||
|
||||
```console
|
||||
```shell
|
||||
coder template push kubernetes -d .
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -1,42 +0,0 @@
|
|||
1. Download and install one of the following system packages from
|
||||
[GitHub releases](https://github.com/coder/coder/releases/latest):
|
||||
|
||||
- .deb (Debian, Ubuntu)
|
||||
- .rpm (Fedora, CentOS, RHEL, SUSE)
|
||||
- .apk (Alpine)
|
||||
|
||||
1. Run Coder as a system service.
|
||||
|
||||
```console
|
||||
# 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's 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).
|
||||
|
||||
1. Visit the Coder URL in the logs to set up your first account, or use the CLI:
|
||||
|
||||
```console
|
||||
coder login <access-url>
|
||||
```
|
||||
|
||||
## 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)
|
||||
|
|
@ -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:
|
||||
<div class="tabs">
|
||||
|
||||
```console
|
||||
## Linux
|
||||
|
||||
<div class="tabs">
|
||||
|
||||
## 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
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
## 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
|
||||
<div class="tabs">
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
||||
|
||||
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 <url> --access-url <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)
|
||||
|
|
@ -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"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
<blockquote class="warning">
|
||||
Before you install
|
||||
If you would like your workspaces to be able to run Docker, we recommend that you <a href="https://github.com/nestybox/sysbox#installation" target="_blank">install Sysbox</a> 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.
|
||||
|
||||
</blockquote>
|
||||
|
||||
## 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
|
||||
```
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
Loading…
Reference in New Issue