mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
chore(docs): reorganize installation docs (#11465)
This commit is contained in:
Muhammad Atif Ali
@@ -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'
|
||||
```
|
||||
|
||||
|
||||
+11
-17
@@ -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..."
|
||||
|
||||
+246
-2
@@ -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)
|
||||
+48
-16
@@ -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)
|
||||
Reference in New Issue
Block a user