Skip to content

feat: one-line install script #1924

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 21 commits into from
Jun 1, 2022
Merged
Changes from 1 commit
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
Prev Previous commit
Next Next commit
first template docs
  • Loading branch information
bpmct committed Jun 1, 2022
commit a16a04a4a38a8b5160a9ac4aed4c394eacaadc1a
60 changes: 1 addition & 59 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,65 +92,7 @@ Coder](https://github.com/coder/coder/releases) installed.
ghcr.io/coder/coder:v0.5.10
```

1. Open a new terminal window, and run `coder login <yourAccessURL>` to create
your first user (once you've done so, you can navigate to `yourAccessURL` and
log in with these credentials).

1. Next, copy a sample template into a new directory so that you can create a custom template in a
subsequent step (be sure that you're working in the directory where you want
your templates stored):

```console
coder templates init
```

Choose the "Develop in Docker" example to generate a sample template in the
`docker` subdirectory.

1. Navigate into the new directory and create a new template:

```console
cd docker
coder templates create
```

Follow the prompts displayed to proceed. When done, you'll see the following
message:

```console
The docker template has been created! Developers can
provision a workspace with this template using:

coder create --template="docker" [workspace name]
```

1. At this point, you're ready to provision your first workspace:

```console
coder create --template="docker" [workspace name]
```

Follow the on-screen prompts to set the parameters for your workspace. If
the process is successful, you'll get information regarding your workspace:

```console
┌─────────────────────────────────────────────────────────────────┐
│ RESOURCE STATUS ACCESS │
├─────────────────────────────────────────────────────────────────┤
│ docker_container.workspace ephemeral │
│ └─ dev (linux, amd64) ⦾ connecting [0s] coder ssh main │
├─────────────────────────────────────────────────────────────────┤
│ docker_volume.coder_volume ephemeral │
└─────────────────────────────────────────────────────────────────┘
The main workspace has been created!
```

You can now access your workspace via your web browser by navigating to your
access URL, or you can connect to it via SSH by running:

```console
coder ssh [workspace name]
```
1. Follow the on-screen instructions to create your first template and workspace

## Manual

Expand Down