diff --git a/.gitignore b/.gitignore index 1b310e84cbde2..f8987b4515389 100644 --- a/.gitignore +++ b/.gitignore @@ -14,6 +14,7 @@ vendor .eslintcache yarn-error.log .idea +.DS_Store # Front-end ignore .next/ diff --git a/README.md b/README.md index dc26257a251bd..4cc78f3bf3d14 100644 --- a/README.md +++ b/README.md @@ -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) +

+ +

-## 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. + +

+ +

+ +[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/). + +

+ +

## Installing Coder diff --git a/docs/images/aws.svg b/docs/images/aws.svg new file mode 100644 index 0000000000000..102d448550f18 --- /dev/null +++ b/docs/images/aws.svg @@ -0,0 +1,48 @@ + + + + + + + + + + + + diff --git a/docs/images/azure.svg b/docs/images/azure.svg new file mode 100644 index 0000000000000..2ff63c104e4ce --- /dev/null +++ b/docs/images/azure.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/images/editors.png b/docs/images/editors.png new file mode 100644 index 0000000000000..409fd5a642835 Binary files /dev/null and b/docs/images/editors.png differ diff --git a/docs/images/gcp.png b/docs/images/gcp.png new file mode 100644 index 0000000000000..2adedff32b125 Binary files /dev/null and b/docs/images/gcp.png differ diff --git a/docs/images/hero-image.png b/docs/images/hero-image.png new file mode 100644 index 0000000000000..9f4686cce73c9 Binary files /dev/null and b/docs/images/hero-image.png differ diff --git a/docs/images/ide-icons.svg b/docs/images/ide-icons.svg new file mode 100644 index 0000000000000..c54f4c084eefc --- /dev/null +++ b/docs/images/ide-icons.svg @@ -0,0 +1,722 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/images/k8s.svg b/docs/images/k8s.svg new file mode 100644 index 0000000000000..bedd3b88e4326 --- /dev/null +++ b/docs/images/k8s.svg @@ -0,0 +1,84 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + diff --git a/docs/images/providers-compute.png b/docs/images/providers-compute.png new file mode 100644 index 0000000000000..313db81f75641 Binary files /dev/null and b/docs/images/providers-compute.png differ diff --git a/docs/images/providers.png b/docs/images/providers.png new file mode 100644 index 0000000000000..bce367885b959 Binary files /dev/null and b/docs/images/providers.png differ diff --git a/docs/images/readme-logos.png b/docs/images/readme-logos.png new file mode 100644 index 0000000000000..ac202cadef683 Binary files /dev/null and b/docs/images/readme-logos.png differ diff --git a/docs/screenshot.png b/docs/screenshot.png deleted file mode 100644 index 1083e2a6ba1b5..0000000000000 Binary files a/docs/screenshot.png and /dev/null differ