Skip to content

Commit ed4a1ce

Browse files
author
Katie Horne
committed
chore: add instructions for deploying with Docker Compose
1 parent e0165c5 commit ed4a1ce

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ destroyed on exit):
5959
> Use `coder --help` to get a complete list of flags and environment
6060
variables.
6161

62+
See the [installation guide](install.md) for additional ways to deploy Coder.
63+
6264
## Creating your first template and workspace
6365

6466
In a new terminal window, run the following to copy a sample template:

docs/install.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Install
2+
3+
This article walks you through the various ways of installing and deploying Coder.
4+
5+
## Docker Compose
6+
7+
Before proceeding, please ensure that you have Docker installed.
8+
9+
1. Clone the `coder` repository:
10+
11+
```console
12+
git clone git@github.com:coder/coder.git
13+
```
14+
15+
1. Navigate into the `coder` folder. Coder requires a non-`localhost` access URL
16+
for non-Docker-based examples; if you have a public IP or a domain/reverse
17+
proxy, you can provide this value prior to running `docker-compose up` to
18+
start the service:
19+
20+
```console
21+
cd coder
22+
CODER_ACCESS_URL=https://coder.mydomain.com
23+
docker-compose up
24+
```
25+
26+
Otherwise, you can simply start the service:
27+
28+
```console
29+
cd coder
30+
docker-compose up
31+
```
32+
33+
Alternatively, if you would like to start a **temporary deployment**:
34+
35+
```console
36+
docker run --rm -it \
37+
-e CODER_DEV_MODE=true \
38+
-v /var/run/docker.sock:/var/run/docker.sock \
39+
ghcr.io/coder/coder:v0.5.10
40+
```
41+
42+
1. Follow the on-screen prompts to create your first user and workspace.

0 commit comments

Comments
 (0)