Quickstart

Quickstart

See our Docker quickstart for the easiest possible way to use Coder.

Generic Quickstart

Please install Coder before proceeding with the steps below.

First time owner user setup

  1. Run coder login <your Access URL> in a new terminal and follow the interactive instructions to create your owner user and password.

If using coder server --tunnel, the Access URL appears in the terminal logs.

Templates

To get started using templates, run the following command to generate a sample template:

coder templates init

Follow the CLI instructions to select an example that you can modify for your specific usage (e.g., a template to Develop code-server in Docker):

  1. Navigate into your new templates folder and create your first template using the provided command (e.g., cd ./docker-code-server && coder templates create)

  2. Answer the CLI prompts; when done, confirm that you want to create your template.

Create a workspace

Now, create a workspace using your template:

coder create --template="yourTemplate" <workspaceName>

Connect to your workspace via SSH:

coder ssh <workspaceName>

To access your workspace in the Coder dashboard, navigate to the configured access URL, and log in with the owner credentials provided to you by Coder.

Coder Web UI with code-server

You can also create workspaces using the access URL and the Templates UI.

Templates UI to create a
workspace

Modifying templates

You can edit the Terraform template as follows:

coder templates init
cd gcp-linux # modify this line as needed to access the template
vim main.tf
coder templates push gcp-linux # updates the template

Up Next

See an opportunity to improve our docs? Make an edit.