"path":"./tutorials/index.md",

"icon_path":"./images/icons/generic.svg",

"children": [

{

"title":"Get started with Coder",

"description":"Learn how to install and run Coder quickly",

"path":"./tutorials/quickstart.md"

},

{

"title":"Write a Template from Scratch",

"description":"Learn how to author Coder templates",

request new topics to be covered.

<children>

This page is rendered onhttps://coder.com/docs/guides. Refer to the other documents in the`guides/` directory for specific employee-written guides.

This page is rendered on<https://coder.com/docs/tutorials>. Refer to the other documents in the`guides/` directory for specific employee-written guides.

</children>

<divstyle="padding:0px;margin:0px;">

<spanstyle="vertical-align:middle;">Author: </span>

<ahref="https://github.com/EdwardAngert"style="text-decoration:none;color:inherit;margin-bottom:0px;">

</a>

</div>

September 23, 2024

Follow the steps in this guide to install Coder locally or on a cloud-hosting

provider, set up a workspace, and connect to it from VS Code.

By the end of this guide, you'll have a remote development environment that you

can connect to from any device anywhere, so you can work on the same files in a

persistent environment from your main device, a tablet, or your phone.

<divclass="tabs">

1. Install Docker:

curl -sSL https://get.docker.com| sh

For more details, visit:

-[Linux instructions](https://docs.docker.com/desktop/install/linux-install/)

-[Mac instructions](https://docs.docker.com/desktop/install/mac-install/)

1. Set up the Docker daemon in rootless mode for your user to run Docker as a

non-privileged user:

dockerd-rootless-setuptool.sh install

Depending on your system's dependencies, you might need to run other commands

before you retry this step. Read the output of this command for further

instructions.

1. Assign your user to the Docker group:

sudo usermod -aG docker$USER

1. Install Coder:

curl -L https://coder.com/install.sh| sh

- For standalone binaries, system packages, or other alternate installation

methods, refer to the

[latest release on GitHub](https://github.com/coder/coder/releases/latest).

1. Start Coder:

coder server

1.[Install Docker](https://docs.docker.com/desktop/install/windows-install/).

1. Use the

package manager to install Coder:

1. Start Coder:

coder server

</div>

1. If you're running Coder locally, go to<http://0.0.0.0:3001/setup>.

- If you get a browser warning similar to`Secure Site Not Available`, you

can ignore the warning and continue to the setup page.

If your Coder server is on a network or cloud device, locate the message in

your terminal that reads,

`View the Web UI: https://<CUSTOM-STRING>.<TUNNEL>.try.coder.app`. The server

begins to stream logs immediately and you might have to scroll up to find it.

1. On the**Welcome to Coder** page, enter the information to create an admin

user, then select**Create account**.

_Welcome

to Coder - Create admin user_

1. On the**Workspaces** page, select**Go to templates** to create a new

template.

1. For this guide, use a Docker container. Locate**Docker Containers** and

select**Use template**.

1. Give the template a**Name** that you'll recognize both in the Coder UI and

in command-line calls.

The rest of the template details are optional, but will be helpful when you

have more templates.

_Create

template_

1. Select**Create template**.

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

1. Give the workspace a name and select**Create Workspace**.

1. Coder starts your new workspace:

_Workspace

is running_

1. 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.

To clone an existing repository:

1. Select**Clone Repository** and enter the repository URL.

For example, to clone the Coder repo, enter

`https://github.com/coder/coder.git`.

Learn more about how to find the repository URL in the

[GitHub documentation](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).

1. Choose the folder to which VS Code should clone the repo. It will be in its

own directory within this folder.

Note that you cannot create a new parent directory in this step.

1. After VS Code completes the clone, select**Open** to open the directory.

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

Now that you have your own workspace, use the same template to set one up for a

teammate.

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).

After that, you can try to:

-[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)

1. Install Docker for your system:

curl -sSL https://get.docker.com| sh

1. Set up the Docker daemon in rootless mode for your user to run Docker as a

non-privileged user:

dockerd-rootless-setuptool.sh install

Depending on your system's dependencies, you might need to run other commands

before you retry this step. Read the output of this command for further

instructions.

1. Assign your user to the Docker group:

sudo usermod -aG docker$USER

1. Confirm that the user has been added:

- Ubuntu users might not see the group membership update. In that case, run

the following command or reboot the machine:

newgrp docker

```

1. Stop the process:

1. Start Coder: