Skip to content

chore: update quickstart (docs) #2381

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.

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
Jun 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added docs/images/code-server.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 7 additions & 2 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This article walks you through the various ways of installing and deploying Code

## install.sh

The easiest way to install Coder is to use our [install script](https://github.com/coder/coder/main/install.sh) for Linux and macOS. The install script
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. The install script
attempts to use the system package manager detection-reference if possible.

You can preview what occurs during the install process:
Expand Down Expand Up @@ -120,5 +120,10 @@ We publish self-contained .zip and .tar.gz archives in [GitHub releases](https:/

```bash
CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<password>" \
coder server
coder server
```

## Next steps

Once you've installed and started Coder, see the [quickstart](./quickstart.md)
for instructions on creating your first template and workspace.
28 changes: 22 additions & 6 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Quickstart

This guide will walk you through creating your first template and workspace. If you haven't already installed `coder`, do that first [here](./install.md).
This guide will walk you through creating your first template and workspace.

## Prerequisites

Please [install Coder](./install.md) before proceeding with the steps outlined in this article.

## Creating your first template and workspace

Expand All @@ -10,8 +14,13 @@ In a new terminal window, run the following to copy a sample template:
coder templates init
```

Follow the CLI instructions to modify and create the template specific for your
usage (e.g., a template to **Develop in Linux on Google Cloud**).
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 using your template:

Expand All @@ -25,13 +34,20 @@ Connect to your workspace via SSH:
coder ssh <workspaceName>
```

You can also access your workspace using the **access URL** you provided when
deploying Coder (if you're using a temporary deployment and you opted to use
Coder's tunnel, use the access URL you were provided). Log in with the admin
credentials provided to you by Coder.

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

## Modifying templates

If needed, you can edit the Terraform template using a sample template:
You can edit the Terraform template as follows:

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