Skip to content

docs: consolidate docker quickstarts #4882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 3, 2022
Merged

docs: consolidate docker quickstarts #4882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
730219b
docs: consolidate docker quickstarts
bpmct Nov 3, 2022
adb842f
Update docs/quickstart/docker.md
ghuntley Nov 3, 2022
2dd1f61
Update docs/quickstart/docker.md
ghuntley Nov 3, 2022
67d10ff
Update docs/quickstart/docker.md
ghuntley Nov 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,19 +76,19 @@
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 I like the specificity of "on a VM"

{
"title": "Google Cloud Platform",
"description": "Setup Coder with Google Cloud Platform",
"description": "Setup Coder on a GCP Compute Engine VM",
"icon_path": "./images/google-cloud.svg",
"path": "./quickstart/google-cloud-platform.md"
},
{
"title": "AWS",
"description": "Setup Coder with AWS",
"description": "Setup Coder on an AWS EC2 VM",
"icon_path": "./images/aws.svg",
"path": "./quickstart/aws.md"
},
{
"title": "Azure",
"description": "Setup Coder with Azure",
"description": "Setup Coder on an Azure VM",
"icon_path": "./images/azure.svg",
"path": "./quickstart/azure.md"
}
Expand Down
69 changes: 5 additions & 64 deletions docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,68 +1,9 @@
# Quickstart

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

## Generic Quickstart
First, pick a platform:

Please [install Coder](./install/index.md) before proceeding with the steps below.

## First time owner user setup

1. Run `coder login <your Access URL>` in a new terminal and follow the
interactive instructions to create your owner user and password.

## Templates

To get started using templates, run the following command to generate a sample template:

```bash
coder templates init
```

Follow the CLI instructions to select an example that you can modify for your
specific usage (e.g., a template to **Develop code-server in Docker**):

1. Navigate into your new templates folder and create your first template using
the provided command (e.g., `cd ./docker-code-server && coder templates create`)

1. Answer the CLI prompts; when done, confirm that you want to create your template.

## Create a workspace

Now, create a workspace using your template:

```bash
coder create --template="yourTemplate" <workspaceName>
```

Connect to your workspace via SSH:

```bash
coder ssh <workspaceName>
```

To access your workspace in the Coder dashboard, navigate to the [configured access URL](./admin/configure.md#access-url),
and log in with the owner credentials provided to you by Coder.

![Coder Web UI with code-server](./images/code-server.png)

You can also create workspaces using the access URL and the Templates UI.

![Templates UI to create a
workspace](./images/create-workspace-from-templates-ui.png)

## Modifying templates

You can edit the Terraform template as follows:

```sh
coder templates init
cd gcp-linux # modify this line as needed to access the template
vim main.tf
coder templates push gcp-linux # updates the template
```

## Up Next

Learn about [templates](./templates.md).
<children>
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.
</children>
35 changes: 21 additions & 14 deletions docs/quickstart/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,34 +13,41 @@ Coder with Docker has the following advantages:

## Instructions

1. [Install and launch Coder](../install)

The Coder server binds to port 3000 by default. Use `--address :<port>` to customize it!

Use the [Coder tunnel](../admin/configure.md#tunnel) for a public URL:

```bash
coder server
1. Run Coder with Docker.

```shell
export CODER_DATA=$HOME/.config/coderv2-docker
export DOCKER_GROUP=$(getent group docker | cut -d: -f3)
mkdir -p $CODER_DATA
docker run --rm -it \
-v $CODER_DATA:/home/coder/.config \
-v /var/run/docker.sock:/var/run/docker.sock \
--group-add $DOCKER_GROUP \
ghcr.io/coder/coder:latest
```

> 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.

Or set an [access URL](../admin/configure.md#access-url) to run entirely locally:

```bash
coder server --access-url=http://localhost:3000 --address=:3000
1. In new terminal, [install Coder](../install/) in order to connect to your deployment through the CLI.

```shell
curl -L https://coder.com/install.sh | sh
```

1. Run `coder login <access url>` in a new terminal and follow the
1. Run `coder login <access url>` and follow the
interactive instructions to create your user.

1. Pull the "Docker" example template using the interactive `coder templates init`:

```bash
```shell
coder templates init
cd docker
```

1. Push up the template with `coder templates create`
1. Open the dashboard in your browser (http://localhost:3000) to create your

1. Open the dashboard in your browser to create your
first workspace:

<img src="../images/quickstart/docker/login.png">
Expand Down