Skip to content

Commit 75da087

Browse files
bpmctbpmct
authored
docs: consolidate docker quickstarts (#4882)
1 parent 04ae4c0 commit 75da087

File tree

3 files changed

+29
-81
lines changed

3 files changed

+29
-81
lines changed

‎docs/manifest.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,19 +76,19 @@
7676
},
7777
{
7878
"title": "Google Cloud Platform",
79-
"description": "Setup Coder with Google Cloud Platform",
79+
"description": "Setup Coder on a GCP Compute Engine VM",
8080
"icon_path": "./images/google-cloud.svg",
8181
"path": "./quickstart/google-cloud-platform.md"
8282
},
8383
{
8484
"title": "AWS",
85-
"description": "Setup Coder with AWS",
85+
"description": "Setup Coder on an AWS EC2 VM",
8686
"icon_path": "./images/aws.svg",
8787
"path": "./quickstart/aws.md"
8888
},
8989
{
9090
"title": "Azure",
91-
"description": "Setup Coder with Azure",
91+
"description": "Setup Coder on an Azure VM",
9292
"icon_path": "./images/azure.svg",
9393
"path": "./quickstart/azure.md"
9494
}

‎docs/quickstart.md

Lines changed: 5 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,9 @@
11
# Quickstart
22

3-
See our [Docker quickstart](./quickstart/docker.md) for the easiest
4-
possible way to use Coder.
3+
Quickstarts are the fastest way to try Coder. We'll walk you through installation and adding your first template and workspace.
54

6-
## Generic Quickstart
5+
First, pick a platform:
76

8-
Please [install Coder](./install/index.md) before proceeding with the steps below.
9-
10-
## First time owner user setup
11-
12-
1. Run `coder login <your Access URL>` in a new terminal and follow the
13-
interactive instructions to create your owner user and password.
14-
15-
## Templates
16-
17-
To get started using templates, run the following command to generate a sample template:
18-
19-
```bash
20-
coder templates init
21-
```
22-
23-
Follow the CLI instructions to select an example that you can modify for your
24-
specific usage (e.g., a template to **Develop code-server in Docker**):
25-
26-
1. Navigate into your new templates folder and create your first template using
27-
the provided command (e.g., `cd ./docker-code-server && coder templates create`)
28-
29-
1. Answer the CLI prompts; when done, confirm that you want to create your template.
30-
31-
## Create a workspace
32-
33-
Now, create a workspace using your template:
34-
35-
```bash
36-
coder create --template="yourTemplate" <workspaceName>
37-
```
38-
39-
Connect to your workspace via SSH:
40-
41-
```bash
42-
coder ssh <workspaceName>
43-
```
44-
45-
To access your workspace in the Coder dashboard, navigate to the [configured access URL](./admin/configure.md#access-url),
46-
and log in with the owner credentials provided to you by Coder.
47-
48-
![Coder Web UI with code-server](./images/code-server.png)
49-
50-
You can also create workspaces using the access URL and the Templates UI.
51-
52-
![Templates UI to create a
53-
workspace](./images/create-workspace-from-templates-ui.png)
54-
55-
## Modifying templates
56-
57-
You can edit the Terraform template as follows:
58-
59-
```sh
60-
coder templates init
61-
cd gcp-linux # modify this line as needed to access the template
62-
vim main.tf
63-
coder templates push gcp-linux # updates the template
64-
```
65-
66-
## Up Next
67-
68-
Learn about [templates](./templates.md).
7+
<children>
8+
This page is rendered on https://coder.com/docs/coder-oss/latest/quickstart. Refer to the other documents in the `install/` directory for per-platform instructions.
9+
</children>

‎docs/quickstart/docker.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,34 +13,41 @@ Coder with Docker has the following advantages:
1313

1414
## Instructions
1515

16-
1. [Install and launch Coder](../install)
17-
18-
The Coder server binds to port 3000 by default. Use `--address :<port>` to customize it!
19-
20-
Use the [Coder tunnel](../admin/configure.md#tunnel) for a public URL:
21-
22-
```bash
23-
coder server
16+
1. Run Coder with Docker.
17+
18+
```shell
19+
export CODER_DATA=$HOME/.config/coderv2-docker
20+
export DOCKER_GROUP=$(getent group docker | cut -d: -f3)
21+
mkdir -p $CODER_DATA
22+
docker run --rm -it \
23+
-v $CODER_DATA:/home/coder/.config \
24+
-v /var/run/docker.sock:/var/run/docker.sock \
25+
--group-add $DOCKER_GROUP \
26+
ghcr.io/coder/coder:latest
2427
```
28+
29+
> This will use Coder's tunnel and built-in database. See our [Docker documentation](../install/docker.md) for other configuration options such as running on localhost, using docker-compose, and external PostgreSQL.
2530
26-
Or set an [access URL](../admin/configure.md#access-url) to run entirely locally:
2731
28-
```bash
29-
coder server --access-url=http://localhost:3000 --address=:3000
32+
1. In new terminal, [install Coder](../install/) in order to connect to your deployment through the CLI.
33+
34+
```shell
35+
curl -L https://coder.com/install.sh | sh
3036
```
3137
32-
1. Run `coder login <access url>` in a new terminal and follow the
38+
1. Run `coder login <access url>` and follow the
3339
interactive instructions to create your user.
3440
3541
1. Pull the "Docker" example template using the interactive `coder templates init`:
3642
37-
```bash
43+
```shell
3844
coder templates init
3945
cd docker
4046
```
4147
4248
1. Push up the template with `coder templates create`
43-
1. Open the dashboard in your browser (http://localhost:3000) to create your
49+
50+
1. Open the dashboard in your browser to create your
4451
first workspace:
4552
4653
<img src="../images/quickstart/docker/login.png">

0 commit comments

Comments
 (0)