Repository files navigation

Provision remote development environments with Terraform.

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

We recommend installingthe latestrelease on a system with at least 1CPU core and 2 GB RAM:

1. Download the release appropriate for your operating system
2. Unzip the folder you just downloaded, and move thecoder executable to alocation that's on yourPATH

Make sure you have the appropriate credentials for your cloud provider (e.g.,access key ID and secret access key for AWS).

You can set up a temporary deployment, a production deployment, or a system service:

• To set up atemporary deployment, start with dev mode (all data is in-memory and isdestroyed on exit):

  coder server --dev

• To run aproduction deployment with PostgreSQL:

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

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

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

Usecoder --help to get a complete list of flags and environmentvariables.

See theinstallation guide for additional ways to deploy Coder.

In a new terminal window, run the following to copy a sample template:

coder templates init

Follow the CLI instructions to modify and create the template specific for yourusage (e.g., a template toDevelop in Linux on Google Cloud).

Create a workspace using your template:

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

Connect to your workspace via SSH:

coder ssh<workspaceName>

You can edit the Terraform template using a sample template:

coder templates initcd gcp-linux/vim main.tfcoder templates update gcp-linux

• About Coder
  • Why remote development
  • Why Coder
  • What Coder is not
  • Comparison: Coder vs. [product]
• Templates
  • Manage templates
  • Persistent and ephemeralresources
  • Parameters
• Workspaces
  • Create workspaces
  • Connect with SSH
  • Editors and IDEs
  • Workspace lifecycle
  • Updating workspaces

Read thecontributing docs.

Find our list of contributorshere.