Skip to content

Commit ba19efb

Browse files
author
Katie Horne
committed
chore: add add'l usage instructions
1 parent ba5e822 commit ba19efb

File tree

1 file changed

+57
-3
lines changed

1 file changed

+57
-3
lines changed

docs/install.md

Lines changed: 57 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Before proceeding, please ensure that you have Docker installed.
1414

1515
1. Navigate into the `coder` folder. Coder requires a non-`localhost` access URL
1616
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
17+
proxy, you can provide this value before running `docker-compose up` to
1818
start the service:
1919

2020
```console
@@ -23,7 +23,7 @@ Before proceeding, please ensure that you have Docker installed.
2323
docker-compose up
2424
```
2525

26-
Otherwise, you can simply start the service:
26+
Otherwise, you can start the service:
2727

2828
```console
2929
cd coder
@@ -39,4 +39,58 @@ Before proceeding, please ensure that you have Docker installed.
3939
ghcr.io/coder/coder:v0.5.10
4040
```
4141

42-
1. Follow the on-screen prompts to create your first user and workspace.
42+
1. Open a new terminal window, and run `coder login <yourAccessURL>` to create
43+
your first user (once you've done so, you can navigate to `yourAccessURL` and
44+
log in with these credentials).
45+
46+
1. Next, copy a sample template into a new directory so that you can create a custom template in a
47+
subsequent step (be sure that you're working in the directory where you want
48+
your templates stored):
49+
50+
```console
51+
coder templates init
52+
```
53+
54+
1. Navigate into the new directory and create a new template:
55+
56+
```console
57+
cd ./docker-local && coder templates create
58+
```
59+
60+
Follow the prompts displayed to proceed. When done, you'll see the following
61+
message:
62+
63+
```console
64+
The docker-local template has been created! Developers can
65+
provision a workspace with this template using:
66+
67+
coder create --template="docker-local" [workspace name]
68+
```
69+
70+
1. At this point, you're ready to provision your first workspace:
71+
72+
```console
73+
coder create --template="docker-local" <yourWorkspaceName>
74+
```
75+
76+
Follow the on-screen prompts to set the parameters for your workspace. If
77+
the process is successful, you'll get information regarding your workspace:
78+
79+
```console
80+
┌─────────────────────────────────────────────────────────────────┐
81+
│ RESOURCE STATUS ACCESS │
82+
├─────────────────────────────────────────────────────────────────┤
83+
│ docker_container.workspace ephemeral │
84+
│ └─ dev (linux, amd64) ⦾ connecting [0s] coder ssh main │
85+
├─────────────────────────────────────────────────────────────────┤
86+
│ docker_volume.coder_volume ephemeral │
87+
└─────────────────────────────────────────────────────────────────┘
88+
The main workspace has been created!
89+
```
90+
91+
You can now access your workspace via your web browser by navigating to your
92+
access URL, or you can connect to it via ssh by running:
93+
94+
```console
95+
coder ssh main
96+
```

0 commit comments

Comments
 (0)