Thanks to visit codestin.com
Credit goes to github.com

Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
c2a8591
Update quickstart docker and coder install steps
david-fraley Sep 9, 2025
cde865d
rest of quickstart
david-fraley Sep 9, 2025
a69b0fb
start of tasks docs
david-fraley Sep 9, 2025
3ff6dac
continued work on tasks
david-fraley Sep 10, 2025
a99a6e5
Updated tasks quickstart section
david-fraley Sep 10, 2025
b74cef8
docs: fix markdown formatting issues in quickstart.md
blink-so[bot] Sep 10, 2025
5d943d7
add back whats next
david-fraley Sep 10, 2025
0d406fd
docs: fix typos and formatting in quickstart.md
blink-so[bot] Sep 10, 2025
a5fdcdd
docs: format quickstart.md with prettier
blink-so[bot] Sep 10, 2025
e3ec375
docs: format markdown tables in quickstart.md
blink-so[bot] Sep 10, 2025
c349ac0
Update tasks how-to
david-fraley Sep 12, 2025
0e1984d
add pic, remove keywords
david-fraley Sep 12, 2025
a211e2a
add note about docker running in background
david-fraley Sep 12, 2025
62ef23a
added picture for changing directories
david-fraley Sep 12, 2025
4e4d27e
revert title change. it'll come later
david-fraley Sep 12, 2025
a0502e6
Merge branch 'main' into david-fraley/update-quickstart
david-fraley Sep 12, 2025
91cb305
minor nit
david-fraley Sep 12, 2025
8dc67ae
updated concepts section
david-fraley Sep 12, 2025
4ef89f0
format
david-fraley Sep 12, 2025
302079d
more format
david-fraley Sep 12, 2025
5ef4945
Fix typo
david-fraley Sep 12, 2025
018f7db
more formats
david-fraley Sep 12, 2025
9bc326e
docs: fix trailing whitespace in quickstart.md
blink-so[bot] Sep 12, 2025
dbe130a
docs: add missing newline at end of quickstart.md
blink-so[bot] Sep 12, 2025
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
rest of quickstart
  • Loading branch information
david-fraley committed Sep 9, 2025
commit cde865d0ff3d42ff4907a077c76d891e0a65d438
89 changes: 49 additions & 40 deletions docs/tutorials/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,45 +120,57 @@ is installed.

</div>

Coder will attempt to open the setup page in your browser. If it doesn't open
automatically, go to <http://localhost:3000>.

## Configure Coder with a new Workspace
- If you get a browser warning similar to `Secure Site Not Available`, you
can ignore the warning and continue to the setup page.

1. Coder will attempt to open the setup page in your browser. If it doesn't open
automatically, go to <http://localhost:3000>.
If your Coder server is on a network or cloud device, or you are having
trouble viewing the page, locate the web UI URL in Coder logs in your
terminal. It looks like `https://<CUSTOM-STRING>.<TUNNEL>.try.coder.app`.
It's one of the first lines of output, so you might have to scroll up to find
it.

- If you get a browser warning similar to `Secure Site Not Available`, you
can ignore the warning and continue to the setup page.
## Step 3: Initial Setup

If your Coder server is on a network or cloud device, or you are having
trouble viewing the page, locate the web UI URL in Coder logs in your
terminal. It looks like `https://<CUSTOM-STRING>.<TUNNEL>.try.coder.app`.
It's one of the first lines of output, so you might have to scroll up to find
it.
1. **Create your admin account:**
- Username: `yourname` (lowercase, no spaces)
- Email: `[email protected]`
- Password: Choose a strong password

1. On the **Welcome to Coder** page, to use your GitHub account to log in,
select **Continue with GitHub**.
You can also enter an email and password to create a new admin account on
the Coder deployment:
You can also choose to **Continue with GitHub** instead of creating an admin account

![Welcome to Coder - Create admin user](../images/screenshots/welcome-create-admin-user.png)_Welcome
to Coder - Create admin user_
![Welcome to Coder - Create admin user](../images/screenshots/welcome-create-admin-user.png)

1. On the **Workspaces** page, select **Go to templates** to create a new
template.
## Step 4: Create your First Template and Workspace

1. For this guide, use a Docker container. Locate **Docker Containers** and
select **Use template**.
Templates define what's in your development environment. Let's start simple:

1. Give the template a **Name** that you'll recognize both in the Coder UI and
in command-line calls.
1. Click **"Templates"** → **"New Template"**

The rest of the template details are optional, but will be helpful when you
have more templates.
2. **Choose a starter template:**

![Create template](../images/screenshots/create-template.png)_Create
template_
| Starter | Best For | Includes |
|---------|----------|----------|
| **Docker Containers** (Recommended) | Getting started quickly, local development, prototyping | Ubuntu container with common dev tools, Docker runtime |
| **Kubernetes (Deployment)** | Cloud-native teams, scalable workspaces | Pod-based workspaces, Kubernetes orchestration |
| **AWS EC2 (Linux)** | Teams needing full VMs, AWS-native infrastructure | Full EC2 instances with AWS integration |

1. Select **Save**.
3. Click **"Use template"** on **Docker Containers**

4. **Name your template:**
- Name: `quickstart`
- Display name: `quickstart doc template`
- Description: `Provision Docker containers as Coder workspaces`

![Create template](../images/screenshots/create-template.png)

5. Click **"Save"**

**What just happened?** You defined a template — a reusable blueprint for dev environments — in your Coder deployment. It’s now stored in your organization’s template list, where you and any teammates in the same org can create workspaces from it. Let’s launch one.

## Step 5: Launch your Workspace

1. After the template is ready, select **Create Workspace**.

Expand All @@ -169,10 +181,9 @@ is installed.
![getting-started-workspace is running](../images/screenshots/workspace-running-with-topbar.png)_Workspace
is running_

1. Select **VS Code Desktop** to install the Coder extension and connect to your
Coder workspace.
## Step 6: Connect your IDE

## Work on some code
Select **VS Code Desktop** to install the Coder extension and connect to your Coder workspace.

After VS Code loads the remote environment, you can select **Open Folder** to
explore directories in the Docker container or work on something new.
Expand All @@ -196,19 +207,17 @@ To clone an existing repository:

1. You are now using VS Code in your Coder environment!

## What's next?

Now that you have your own workspace, use the same template to set one up for a
teammate.
## Success! You're Coding in Coder

Go to **Templates** and select **Create Workspace** and continue from Step 7 in
[Configure Coder with a new workspace](#configure-coder-with-a-new-workspace).
You now have:
- **Coder server** running locally
- **A template** defining your environment
- **A workspace** running that environment
- **IDE access** to code remotely

After that, you can try to:
### Get Coder Tasks Running

- [Customize templates](../admin/templates/extending-templates/index.md)
- [Enable Prometheus metrics](../admin/integrations/prometheus.md)
- [Deploy to Google Cloud Platform (GCP)](../install/cloud/compute-engine.md)
tbd @david

## Troubleshooting

Expand Down
Loading