Skip to content

Rewrite README for launch #1731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
May 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ vendor
.eslintcache
yarn-error.log
.idea
.DS_Store

# Front-end ignore
.next/
Expand Down
61 changes: 50 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,61 @@ Discord"](https://img.shields.io/badge/join-us%20on%20Discord-gray.svg?longCache
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)

Team-wide CLI for spawning up dev servers on demand, powered by Terraform.
Coder turns your cloud into a fleet of remote development servers.

![Kubernetes workspace in Coder v2](./docs/screenshot.png)
<p align="center">
<img src="./docs/images/hero-image.png">
</p>

## Highlights
**Code more**

Workspaces:
- Code on powerful servers: leverage cloud GPU, GPU, and network speeds
- Use the `coder` CLI: connect via SSH, VS Code, and JetBrains
- Self-serve workspaces: start from team-wide templates (see below)
- Build and test faster
- Leveraging cloud CPUs, RAM, network speeds, etc.
- Access your environment from any place on any client (even an iPad)
- Onboard instantly then stay up to date continuously

Templates:
- Manage the infrastructure behind workspaces with standard Terraform (`.hcl` files)
- Use any OS and architecture: Mac, Windows, Linux, VM, Kubernetes, ARM, etc
- Auto-shutdown or update workspaces when they're not in use!
**Manage less**

- Ensure your entire team is using the same tools and resources
- Rollout critical updates to your developers with one command
- Automatically shut down expensive cloud resources
- Keep your source code and data behind your firewall

## How it works

Coder workspaces are represented with Terraform. But, no Terraform knowledge is
required to get started. We have a database of pre-made templates built into the
product. Terraform empowers you to create
environments on _anything_, including:

- Cloud VMs
- Kubernetes containers (including AKS, EKS, GKS)
- Docker containers
- Dedicated servers (Hetzner, OVH, etc.)
- Linux, Windows and MacOS environments

Coder workspaces don't stop at compute. You can add storage buckets, secrets, sidecars
and whatever else Terraform lets you dream up.

<p align="center">
<img src="./docs/images/providers-compute.png">
</p>

[Learn more about managing infrastructure.](./docs/templates.md)

## IDE Support

Coder gives you a few ways of accessing your workspace:

- `coder port-forward` a remote port to a local port
- `coder ssh`
- A URL interface to HTTP services

With these methods, you can use any Web IDE ([code-server](https://github.com/coder/code-server), [projector](https://github.com/JetBrains/projector-server), [Jupyter](https://jupyter.org/), etc.), [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/), [VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial) or even a file sync such as [mutagen](https://mutagen.io/).

<p align="center">
<img src="./docs/images/ide-icons.svg" height=72>
</p>

## Installing Coder

Expand Down
48 changes: 48 additions & 0 deletions docs/images/aws.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/images/azure.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/editors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/gcp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/hero-image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading