Skip to content

Commit 94282aa

Browse files
EdwardAngertEdwardAngert
committed
revert 14744 without removing files
1 parent 0fba291 commit 94282aa

File tree

5 files changed

+192
-5
lines changed

5 files changed

+192
-5
lines changed

‎docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,4 +143,4 @@ or [the v2 migration guide and FAQ](https://coder.com/docs/v1/guides/v2-faq).
143143

144144
- Learn about [Templates](./admin/templates/index.md)
145145
- [Install Coder](./install/index.md)
146-
- Follow the [Quickstart guide](./tutorials/quickstart.md) to try Coder out for yourself.
146+
- Follow the [Quickstart guide](./start/coder-tour.md) to try Coder out for yourself.

‎docs/admin/templates/managing-templates/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Working with templates
22

33
You create and edit Coder templates as
4-
[Terraform](../../../tutorials/quickstart.md) configuration files (`.tf`) and
4+
[Terraform](../../../start/coder-tour.md) configuration files (`.tf`) and
55
any supporting files, like a README or configuration files for other services.
66

77
## Who creates templates?

‎docs/install/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,5 +64,5 @@ coder login https://coder.example.com
6464

6565
## Next steps
6666

67-
- [Set up your first deployment](../tutorials/quickstart.md)
67+
- [Set up your first deployment](../start/coder-tour.md)
6868
- [Expose your control plane to other users](../admin/setup/index.md)

‎docs/manifest.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
{
1111
"title": "Coder quickstart",
1212
"description": "Try it out for yourself",
13-
"path": "./tutorials/quickstart.md"
13+
"path": "./start/coder-tour.md"
1414
},
1515
{
1616
"title": "Screenshots",
@@ -637,7 +637,7 @@
637637
{
638638
"title": "Get started with Coder",
639639
"description": "Learn how to install and run Coder quickly",
640-
"path": "./tutorials/quickstart.md"
640+
"path": "./start/coder-tour.md"
641641
},
642642
{
643643
"title": "Write a Template from Scratch",

‎docs/start/coder-tour.md

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
## Tour Coder and Set up your first deployment.
2+
3+
For day-zero Coder users, we recommend following this guide to set up a local
4+
Coder deployment, create your first template, and connect to a workspace. This
5+
is completely free and leverages our
6+
[open source repository](https://github.com/coder/coder).
7+
8+
We'll use [Docker](https://docs.docker.com/engine) to manage the compute for a
9+
slim deployment to experiment with [workspaces](../user-guides/index.md) and
10+
[templates](../admin/templates/index.md).
11+
12+
Docker is not necessary for every Coder deployment and is only used here for
13+
simplicity.
14+
15+
# Set up your Coder Deployment
16+
17+
## 1. Install Docker
18+
19+
First, install [Docker](https://docs.docker.com/engine/install/) locally.
20+
21+
> If you already have the Coder binary installed, restart it after installing
22+
> Docker.
23+
24+
## 2. Install Coder daemon
25+
26+
<div class="tabs">
27+
28+
## Linux/macOS
29+
30+
Our install script is the fastest way to install Coder on Linux/macOS:
31+
32+
```sh
33+
curl -L https://coder.com/install.sh | sh
34+
```
35+
36+
## Windows
37+
38+
> **Important:** If you plan to use the built-in PostgreSQL database, you will
39+
> need to ensure that the
40+
> [Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version)
41+
> is installed.
42+
43+
You can use the
44+
[`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget)
45+
package manager to install Coder:
46+
47+
```powershell
48+
winget install Coder.Coder
49+
```
50+
51+
</div>
52+
53+
## 3. Start the server
54+
55+
To start or restart the Coder deployment, use the following command:
56+
57+
```shell
58+
coder server
59+
```
60+
61+
The output will provide you with a URL to access your deployment, where you'll
62+
create your first administrator account.
63+
64+
![Coder login screen](../images/start/setup-page.png)
65+
66+
Once you've signed in, you'll be brought to an empty workspaces page, which
67+
we'll soon populate with your first development environments.
68+
69+
### More information on the Coder Server
70+
71+
# Create your first template
72+
73+
A common way to create a template is to begin with a starter template then
74+
modify it for your needs. Coder makes this easy with starter templates for
75+
popular development targets like Docker, Kubernetes, Azure, and so on. Once your
76+
template is up and running, you can edit it in the Coder dashboard. Coder even
77+
handles versioning for you so you can publish official updates or revert to
78+
previous versions.
79+
80+
In this tutorial, you'll create your first template from the Docker starter
81+
template.
82+
83+
## 1. Choose a starter template
84+
85+
Select **Templates** to see the **Starter Templates**. Use the **Docker
86+
Containers** template by pressing **Use Template**.
87+
88+
![Starter Templates UI](../images/start/starter-templates-annotated.png)
89+
90+
> You can also a find a comprehensive list of starter templates in **Templates**
91+
> -> **Create Template** -> **Starter Templates**.
92+
93+
## 2. Create your template
94+
95+
In **Create template**, fill in **Name** and **Display name**, then select
96+
**Create template**.
97+
98+
![Creating a template](../images/start/create-template.png)
99+
100+
TODO:
101+
102+
- add CLI guide for making a new template
103+
- refactor text below to be more beginner-friendly
104+
105+
# Create a workspace
106+
107+
## 1. Create a workspace from your template
108+
109+
When the template is ready, select **Create Workspace**.
110+
111+
![Template Preview](../images/start/template-preview.png)
112+
113+
In **New workspace**, fill in **Name** then scroll down to select **Create
114+
Workspace**.
115+
116+
![Create Workspace](../images/start/create-workspace.png)
117+
118+
Coder starts your new workspace from your template.
119+
120+
After a few seconds, your workspace is ready to use.
121+
122+
![Workspace is ready](../images/start/workspace-ready.png)
123+
124+
## 4. Try out your new workspace
125+
126+
This starter template lets you connect to your workspace in a few ways:
127+
128+
- VS Code Desktop: Loads your workspace into
129+
[VS Code Desktop](https://code.visualstudio.com/Download) installed on your
130+
local computer.
131+
- code-server: Opens
132+
[browser-based VS Code](../user-guides/workspace-access/vscode.md) with your
133+
workspace.
134+
- Terminal: Opens a browser-based terminal with a shell in the workspace's
135+
Docker instance.
136+
- SSH: Use SSH to log in to the workspace from your local machine. If you
137+
haven't already, you'll have to install Coder on your local machine to
138+
configure your SSH client.
139+
140+
> **Tip**: You can edit the template to let developers connect to a workspace in
141+
> [a few more ways](../admin/templates/managing-templates/devcontainers.md).
142+
143+
When you're done, you can stop the workspace.
144+
145+
## 6. Modify your template
146+
147+
Now you can modify your template to suit your team's needs.
148+
149+
Let's replace the `golang` package in the Docker image with the `python3`
150+
package. You can do this by editing the template's `Dockerfile` directly in your
151+
web browser.
152+
153+
In the Coder dashboard, select **Templates** then your first template.
154+
155+
![Selecting the first template](../images/templates/select-template.png)
156+
157+
In the drop-down menu, select **Edit files**.
158+
159+
![Edit template files](../images/templates/edit-files.png)
160+
161+
Expand the **build** directory and select **Dockerfile**.
162+
163+
![Selecting source code](../images/templates/source-code.png)
164+
165+
Edit `build/Dockerfile` to replace `golang` with `python3`.
166+
167+
![Editing source code](../images/templates/edit-source-code.png)
168+
169+
Select **Build template** and wait for Coder to prepare the template for
170+
workspaces.
171+
172+
![Building a template](../images/templates/build-template.png)
173+
174+
Select **Publish version**. In the **Publish new version** dialog, make sure
175+
**Promote to default version** is checked then select **Publish**.
176+
177+
![Publish a template](../images/templates/publish.png)
178+
179+
Now when developers create a new workspace from this template, they can use
180+
Python 3 instead of Go.
181+
182+
For developers with workspaces that were created with a previous version of your
183+
template, Coder will notify them that there's a new version of the template.
184+
185+
You can also handle
186+
[change management](../admin/templates/managing-templates/change-management.md)
187+
through your own repo and continuous integration.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy