coder/docs

Coder

Provision remote development environments with Terraform.

Highlights

• Automate development environments for Linux, Windows, and macOS
• Start writing code with a single command
• Get started quickly using one of the examples provided

Installing Coder

Install the latest release on a system with at least 1 CPU core and 2 GB RAM.

To test, start with dev mode (all data is in-memory and is destroyed on exit):

coder server --dev

To run a production deployment with PostgreSQL:

CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<password>" \
    coder server

To run as a system service, install with .deb (Debian, Ubuntu) or .rpm (Fedora, CentOS, RHEL, SUSE):

# Edit the configuration!
sudo vim /etc/coder.d/coder.env
sudo service coder restart

Use coder start --help to get a complete list of flags and environment variables.

Your first workspace

In a new terminal, create a template (e.g., a template to Develop in Linux on Google Cloud):

coder templates init
coder templates create

Create a workspace and connect to it via SSH:

coder workspaces create my-first-workspace
coder ssh my-first-workspace

Modifying templates

You can edit the Terraform template using a sample template:

coder templates init
cd gcp-linux/
vim main.tf
coder templates update gcp-linux

Documentation

• About Coder
  • Why remote development
  • Why Coder
  • What Coder is not
• Templates
  • Manage templates
  • Persistent and ephemeral resources
  • Variables
• Workspaces
  • Create workspaces
  • Connect with SSH
  • Editors and IDEs
  • Workspace lifecycle
  • Updating workspaces

Contributing

Read the contributing docs.