Steven Masley d3a0578fe1 feat: Allow regen-ssh and fetching a single user from the cli (#1619)
* feat: Allow regen-ssh and fetching a single user from the cli
2022-05-24 16:53:04 +00:00
2022-04-04 11:55:06 -05:00
2022-05-21 00:39:51 +01:00

Coder

"GitHub
Discussions" "Join us on
Discord" Twitter
Follow codecov

Provision remote development environments with Terraform.

Kubernetes workspace in Coder v2

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

We recommend installing the latest release on a system with at least 1 CPU core and 2 GB RAM:

  1. Download the release appropriate for your operating system
  2. Unzip the folder you just downloaded, and move the coder executable to a location that's on your PATH

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 a temporary deployment, 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 --help to get a complete list of flags and environment variables.

See the installation guide for additional ways to deploy Coder.

Creating your first template and workspace

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 your usage (e.g., a template to Develop 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>

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

Contributing

Read the contributing docs.

Contributors

Find our list of contributors here.

Languages
Go 75.4%
TypeScript 20.9%
Shell 1.4%
HCL 1.1%
PLpgSQL 0.3%
Other 0.6%