2022-03-28 20:21:00 +00:00
|
|
|
# Coder
|
2022-01-04 02:54:27 +00:00
|
|
|
|
2022-04-26 17:10:50 +00:00
|
|
|
[!["GitHub
|
|
|
|
Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/coder/coder/discussions)
|
|
|
|
[!["Join us on
|
2022-05-18 21:14:31 +00:00
|
|
|
Discord"](https://img.shields.io/badge/join-us%20on%20Discord-gray.svg?longCache=true&logo=discord&colorB=purple)](https://discord.gg/coder)
|
2022-04-26 17:10:50 +00:00
|
|
|
[![Twitter
|
|
|
|
Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq)
|
|
|
|
[![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder)
|
2022-01-03 18:52:07 +00:00
|
|
|
|
2022-03-28 20:21:00 +00:00
|
|
|
Provision remote development environments with Terraform.
|
2022-01-04 02:54:27 +00:00
|
|
|
|
2022-05-20 16:56:50 +00:00
|
|
|
![Kubernetes workspace in Coder v2](./docs/screenshot.png)
|
2022-05-06 01:09:27 +00:00
|
|
|
|
2022-03-28 20:21:00 +00:00
|
|
|
## Highlights
|
2022-01-03 18:52:07 +00:00
|
|
|
|
2022-04-26 17:10:50 +00:00
|
|
|
- Automate development environments for Linux, Windows, and macOS
|
2022-03-28 20:21:00 +00:00
|
|
|
- Start writing code with a single command
|
2022-05-20 16:56:50 +00:00
|
|
|
- Get started quickly using one of the [examples](./examples) provided
|
2022-01-03 18:52:07 +00:00
|
|
|
|
2022-04-26 17:10:50 +00:00
|
|
|
## Installing Coder
|
2022-01-11 21:05:49 +00:00
|
|
|
|
2022-05-19 13:01:19 +00:00
|
|
|
We recommend installing [the latest
|
|
|
|
release](https://github.com/coder/coder/releases) on a system with at least 1
|
|
|
|
CPU core and 2 GB RAM:
|
2022-02-11 04:32:00 +00:00
|
|
|
|
2022-05-19 13:01:19 +00:00
|
|
|
1. Download the release appropriate for your operating system
|
|
|
|
1. Unzip the folder you just downloaded, and move the `coder` executable to a
|
|
|
|
location that's on your `PATH`
|
2022-02-09 21:46:46 +00:00
|
|
|
|
2022-05-19 13:01:19 +00:00
|
|
|
> Make sure you have the appropriate credentials for your cloud provider (e.g.,
|
|
|
|
> access key ID and secret access key for AWS).
|
2022-03-16 03:55:21 +00:00
|
|
|
|
2022-05-19 13:01:19 +00:00
|
|
|
You can set up a temporary deployment, a production deployment, or a system service:
|
2022-03-16 03:55:21 +00:00
|
|
|
|
2022-05-19 13:01:19 +00:00
|
|
|
- To set up a **temporary deployment**, start with dev mode (all data is in-memory and is
|
2022-05-20 16:56:50 +00:00
|
|
|
destroyed on exit):
|
2022-05-19 13:01:19 +00:00
|
|
|
|
|
|
|
```bash
|
|
|
|
coder server --dev
|
|
|
|
```
|
|
|
|
|
|
|
|
- To run a **production deployment** with PostgreSQL:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<password>" \
|
|
|
|
coder server
|
|
|
|
```
|
2022-03-16 03:55:21 +00:00
|
|
|
|
2022-05-19 13:01:19 +00:00
|
|
|
- To run as a **system service**, install with `.deb` (Debian, Ubuntu) or `.rpm`
|
2022-05-20 16:56:50 +00:00
|
|
|
(Fedora, CentOS, RHEL, SUSE):
|
2022-03-16 03:55:21 +00:00
|
|
|
|
2022-05-19 13:01:19 +00:00
|
|
|
```bash
|
|
|
|
# Edit the configuration!
|
|
|
|
sudo vim /etc/coder.d/coder.env
|
|
|
|
sudo service coder restart
|
|
|
|
```
|
2022-03-16 03:55:21 +00:00
|
|
|
|
2022-05-19 13:01:19 +00:00
|
|
|
> Use `coder --help` to get a complete list of flags and environment
|
2022-05-20 16:56:50 +00:00
|
|
|
> variables.
|
2022-03-16 03:55:21 +00:00
|
|
|
|
2022-05-23 19:42:45 +00:00
|
|
|
See the [installation guide](install.md) for additional ways to deploy Coder.
|
|
|
|
|
2022-05-19 13:01:19 +00:00
|
|
|
## Creating your first template and workspace
|
2022-02-09 21:46:46 +00:00
|
|
|
|
2022-05-19 13:01:19 +00:00
|
|
|
In a new terminal window, run the following to copy a sample template:
|
2022-04-26 17:10:50 +00:00
|
|
|
|
|
|
|
```bash
|
|
|
|
coder templates init
|
2022-03-28 20:21:00 +00:00
|
|
|
```
|
2022-02-09 21:46:46 +00:00
|
|
|
|
2022-05-19 13:01:19 +00:00
|
|
|
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:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
coder create --template="yourTemplate" <workspaceName>
|
|
|
|
```
|
|
|
|
|
|
|
|
Connect to your workspace via SSH:
|
2022-03-16 03:55:21 +00:00
|
|
|
|
2022-04-26 17:10:50 +00:00
|
|
|
```bash
|
2022-05-19 13:01:19 +00:00
|
|
|
coder ssh <workspaceName>
|
2022-03-28 20:21:00 +00:00
|
|
|
```
|
2022-03-16 03:55:21 +00:00
|
|
|
|
2022-05-19 13:01:19 +00:00
|
|
|
## Modifying templates
|
2022-04-01 18:48:45 +00:00
|
|
|
|
2022-04-26 17:10:50 +00:00
|
|
|
You can edit the Terraform template using a sample template:
|
2022-04-01 18:48:45 +00:00
|
|
|
|
|
|
|
```sh
|
2022-04-26 17:10:50 +00:00
|
|
|
coder templates init
|
|
|
|
cd gcp-linux/
|
|
|
|
vim main.tf
|
|
|
|
coder templates update gcp-linux
|
2022-04-01 18:48:45 +00:00
|
|
|
```
|
|
|
|
|
2022-04-26 17:10:50 +00:00
|
|
|
## Documentation
|
|
|
|
|
2022-05-20 16:56:50 +00:00
|
|
|
- [About Coder](./docs/about.md#about-coder)
|
|
|
|
- [Why remote development](./docs/about.md#why-remote-development)
|
|
|
|
- [Why Coder](./docs/about.md#why-coder)
|
|
|
|
- [What Coder is not](./docs/about.md#what-coder-is-not)
|
|
|
|
- [Comparison: Coder vs. [product]](./docs/about.md#comparison)
|
|
|
|
- [Templates](./docs/templates.md)
|
|
|
|
- [Manage templates](./docs/templates.md#manage-templates)
|
2022-04-26 17:10:50 +00:00
|
|
|
- [Persistent and ephemeral
|
2022-05-20 16:56:50 +00:00
|
|
|
resources](./docs/templates.md#persistent-and-ephemeral-resources)
|
|
|
|
- [Parameters](./docs/templates.md#parameters)
|
|
|
|
- [Workspaces](./docs/workspaces.md)
|
|
|
|
- [Create workspaces](./docs/workspaces.md#create-workspaces)
|
|
|
|
- [Connect with SSH](./docs/workspaces.md#connect-with-ssh)
|
|
|
|
- [Editors and IDEs](./docs/workspaces.md#editors-and-ides)
|
|
|
|
- [Workspace lifecycle](./docs/workspaces.md#workspace-lifecycle)
|
|
|
|
- [Updating workspaces](./docs/workspaces.md#updating-workspaces)
|
2022-04-26 17:10:50 +00:00
|
|
|
|
2022-04-06 17:26:17 +00:00
|
|
|
## Contributing
|
2022-01-11 21:05:49 +00:00
|
|
|
|
2022-05-20 16:56:50 +00:00
|
|
|
Read the [contributing docs](./docs/CONTRIBUTING.md).
|
2022-04-27 11:48:45 +00:00
|
|
|
|
|
|
|
## Contributors
|
|
|
|
|
2022-05-23 19:09:45 +00:00
|
|
|
Find our list of contributors [here](./CONTRIBUTORS.md).
|