Ben Potter 22668c388c feat: initial docs pages (#1107)
* docs structure and edits to getting started

* draft for about page

* skeleton for concepts page

* attempt at explaining templates

* left-align tables

* add best practices and variables

* update structrure

* update structure

* templates are shared

* workspaces docs

* remove coming soon

* fix typos

* docs structure and edits to getting started

* draft for about page

* skeleton for concepts page

* attempt at explaining templates

* left-align tables

* add best practices and variables

* update structrure

* update structure

* templates are shared

* workspaces docs

* remove coming soon

* fix typos

* fix typos

* Update docs/about.md

Co-authored-by: Joe Previte <jjprevite@gmail.com>

* remove line breaks between bullets

* rename variables to parameters

* reduce limits

* chore: edit text

* revert some changes, fix footnotes

Co-authored-by: Katie Horne <katie@coder.com>
Co-authored-by: Joe Previte <jjprevite@gmail.com>
2022-04-26 12:10:50 -05:00
2022-04-26 12:10:50 -05:00
2022-04-25 18:57:59 +00:00
2022-04-25 18:57:59 +00:00
2022-04-04 11:55:06 -05:00

Coder

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

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

Contributing

Read the contributing docs.

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