|
1 |
| -# About Coder |
| 1 | +# What is Coder |
2 | 2 |
|
3 |
| -Coder is an open-source platform for creating and managing developer workspaces |
4 |
| -on your preferred clouds and servers. |
| 3 | +Coder is a self-hosted, open source, cloud development environment that works |
| 4 | +with any cloud, IDE, OS, Git provider, and IDP. |
5 | 5 |
|
6 |
| -<p align="center"> |
7 |
| - <img src="./images/hero-image.png"> |
8 |
| -</p> |
| 6 | +_Screenshots of Coder workspaces and connections_ |
9 | 7 |
|
10 |
| -By building on top of common development interfaces (SSH) and infrastructure tools (Terraform), Coder aims to make the process of **provisioning** and **accessing** remote workspaces approachable for organizations of various sizes and stages of cloud-native maturity. |
| 8 | +Coder is built on common development interfaces and infrastructure tools to |
| 9 | +make the process of provisioning and accessing remote workspaces approachable |
| 10 | +for organizations of various sizes and stages of cloud-native maturity. |
11 | 11 |
|
12 |
| -<blockquote class="warning"> |
13 |
| - <p> |
14 |
| - If you are a Coder v1 customer, view <a href="https://coder.com/docs/coder">the docs</a> or <a href="https://coder.com/docs/coder/latest/guides/v2-faq">the sunset plans</a>. |
15 |
| - </p> |
16 |
| -</blockquote> |
| 12 | +> **Using Coder v1?** |
| 13 | +> |
| 14 | +> If you're a Coder v1 customer, view [the v1 documentation](https://coder.com/docs/v1) |
| 15 | +or [the v2 migration guide and FAQ](https://coder.com/docs/v1/guides/v2-faq). |
17 | 16 |
|
18 |
| -## How it works |
| 17 | +## IDE support |
19 | 18 |
|
20 |
| -Coder workspaces are represented with Terraform, but no Terraform knowledge is |
21 |
| -required to get started. We have a [database](https://registry.coder.com/templates) of pre-made templates built into the |
22 |
| -product. |
| 19 | + |
23 | 20 |
|
24 |
| -<p align="center"> |
25 |
| - <img src="./images/providers-compute.png"> |
26 |
| -</p> |
| 21 | +You can use: |
27 | 22 |
|
28 |
| -Coder workspaces don't stop at compute. You can add storage buckets, secrets, sidecars |
29 |
| -and whatever else Terraform lets you dream up. |
| 23 | +- Any Web IDE, such as |
| 24 | + - The built-in [VS Code code-server](https://github.com/coder/code-server) |
| 25 | + - [JetBrains Projector](https://github.com/JetBrains/projector-server) |
| 26 | + - [Jupyter](https://jupyter.org/) |
| 27 | + - And others |
30 | 28 |
|
31 |
| -[Learn more about templates.](./admin/templates/README.md) |
| 29 | +- Your existing remote development environment: |
| 30 | + - [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/) |
| 31 | + - [VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial) |
| 32 | + - [Emacs](./ides/emacs-tramp) |
32 | 33 |
|
33 |
| -## IDE Support |
34 |
| - |
35 |
| -You can use any [Web IDE](./admin/templates/extending-templates/web-ides.md) ([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/). |
36 |
| - |
37 |
| -<p align="center"> |
38 |
| - <img src="./images/ide-icons.svg" height=72> |
39 |
| -</p> |
| 34 | +- File sync such as [Mutagen](https://mutagen.io/) |
40 | 35 |
|
41 | 36 | ## Why remote development
|
42 | 37 |
|
43 |
| -Migrating from local developer machines to workspaces hosted by cloud services |
44 |
| -is an [increasingly common solution for |
45 |
| -developers](https://blog.alexellis.io/the-internet-is-my-computer/) and |
46 |
| -[organizations |
47 |
| -alike](https://slack.engineering/development-environments-at-slack). There are |
48 |
| -several benefits, including: |
| 38 | +Remote development offers several benefits for users and administrators, including: |
| 39 | + |
| 40 | +- **Increased speed** |
| 41 | + - Server-grade cloud hardware speeds up operations in software development, from |
| 42 | + loading the IDE to compiling and building code, and running large workloads |
| 43 | + such as those for monolith or microservice applications. |
49 | 44 |
|
50 |
| -- **Increased speed:** Server-grade compute speeds up operations in software |
51 |
| - development, such as IDE loading, code compilation and building, and the |
52 |
| - running of large workloads (such as those for monolith or microservice |
53 |
| - applications) |
| 45 | +- **Easier environment management** |
| 46 | + - Built-in infrastructure tools such as Terraform, nix, Docker, Dev Containers, and others make it easier to onboard developers with consistent environments. |
54 | 47 |
|
55 |
| -- **Easier environment management:** Tools such as Terraform, nix, Docker, |
56 |
| - devcontainers, and so on make developer onboarding and the troubleshooting of |
57 |
| - development environments easier |
| 48 | +- **Increased security** |
| 49 | + - Centralize source code and other data onto private servers or cloud services instead of local developers' machines. |
| 50 | + - Provision and manage users with [SSO](https://coder.com/docs/admin/auth) and [Role-based access controlled (RBAC)](https://coder.com/docs/admin/rbac). |
58 | 51 |
|
59 |
| -- **Increase security:** Centralize source code and other data onto private |
60 |
| - servers or cloud services instead of local developer machines |
| 52 | +- **Improved compatibility** |
| 53 | + - Remote workspaces can share infrastructure configurations with other |
| 54 | + development, staging, and production environments, reducing configuration |
| 55 | + drift. |
61 | 56 |
|
62 |
| -- **Improved compatibility:** Remote workspaces share infrastructure |
63 |
| - configuration with other development, staging, and production environments, |
64 |
| - reducing configuration drift |
| 57 | +- **Improved accessibility** |
| 58 | + - Connect to remote workspaces via browser-based IDEs or remote IDE |
| 59 | + extensions to enable developers regardless of the device they use, whether |
| 60 | + it's their main device, a lightweight laptop, Chromebook, or iPad. |
65 | 61 |
|
66 |
| -- **Improved accessibility:** Devices such as lightweight notebooks, |
67 |
| - Chromebooks, and iPads can connect to remote workspaces via browser-based IDEs |
68 |
| - or remote IDE extensions |
| 62 | +Read more about why organizations and engineers are moving to remote |
| 63 | +development on [our blog](https://coder.com/blog), the |
| 64 | +[Slack engineering blog](https://slack.engineering/development-environments-at-slack), |
| 65 | +or from [OpenFaaS's Alex Ellis](https://blog.alexellis.io/the-internet-is-my-computer/). |
69 | 66 |
|
70 | 67 | ## Why Coder
|
71 | 68 |
|
72 |
| -The key difference between Coder OSS and other remote IDE platforms is the added |
73 |
| -layer of infrastructure control. This additional layer allows admins to: |
| 69 | +The key difference between Coder and other remote IDE platforms is the added |
| 70 | +layer of infrastructure control. |
| 71 | +This additional layer allows admins to: |
74 | 72 |
|
75 |
| -- Support ARM, Windows, Linux, and macOS workspaces |
76 |
| -- Modify pod/container specs (e.g., adding disks, managing network policies, |
77 |
| - setting/updating environment variables) |
78 |
| -- Use VM/dedicated workspaces, developing with Kernel features (no container |
79 |
| - knowledge required) |
| 73 | +- Simultaneously support ARM, Windows, Linux, and macOS workspaces. |
| 74 | +- Modify pod/container specs, such as adding disks, managing network policies, or |
| 75 | + setting/updating environment variables. |
| 76 | +- Use VM or dedicated workspaces, developing with Kernel features (no container |
| 77 | + knowledge required). |
80 | 78 | - Enable persistent workspaces, which are like local machines, but faster and
|
81 |
| - hosted by a cloud service |
| 79 | + hosted by a cloud service. |
| 80 | + |
| 81 | +## How much does it cost? |
| 82 | + |
| 83 | +Coder is free and open source under |
| 84 | +[GNU Affero General Public License v3.0](https://github.com/coder/coder/blob/main/LICENSE). |
| 85 | +All developer productivity features are included in the Open Source version of |
| 86 | +Coder. |
| 87 | +An [Enterprise license is available](https://coder.com/pricing) for enhanced |
| 88 | +support options and custom deployments. |
| 89 | + |
| 90 | +## How does Coder work |
| 91 | + |
| 92 | +Coder workspaces are represented with Terraform, but you don't need to know |
| 93 | +Terraform to get started. |
| 94 | +We have a [database of production-ready templates](https://registry.coder.com/templates) |
| 95 | +for use with AWS EC2, Azure, Google Cloud, Kubernetes, and more. |
| 96 | + |
| 97 | +_Providers and compute environments_ |
| 98 | + |
| 99 | +Coder workspaces can be used for more than just compute. |
| 100 | +You can use Terraform to add storage buckets, secrets, sidecars, |
| 101 | +[and more](https://developer.hashicorp.com/terraform/tutorials). |
82 | 102 |
|
83 |
| -Coder includes [production-ready templates](https://registry.coder.com/templates) for use with AWS EC2, |
84 |
| -Azure, Google Cloud, Kubernetes, and more. |
| 103 | +Visit the [templates documentation](./admin/templates/README.md) to learn more. |
85 | 104 |
|
86 |
| -## What Coder is _not_ |
| 105 | +## What Coder is not |
87 | 106 |
|
88 |
| -- Coder is not an infrastructure as code (IaC) platform. Terraform is the first |
89 |
| - IaC _provisioner_ in Coder, allowing Coder admins to define Terraform |
90 |
| - resources as Coder workspaces. |
| 107 | +- Coder is not an infrastructure as code (IaC) platform. |
| 108 | + - Terraform is the first IaC _provisioner_ in Coder, allowing Coder admins to |
| 109 | + define Terraform resources as Coder workspaces. |
91 | 110 |
|
92 |
| -- Coder is not a DevOps/CI platform. Coder workspaces can follow best practices |
93 |
| - for cloud service-based workloads, but Coder is not responsible for how you |
| 111 | +- Coder is not a DevOps/CI platform. |
| 112 | + - Coder workspaces can be configured to follow best practices for |
| 113 | + cloud-service-based workloads, but Coder is not responsible for how you |
94 | 114 | define or deploy the software you write.
|
95 | 115 |
|
96 |
| -- Coder is not an online IDE. Instead, Coder supports common editors, such as VS |
97 |
| - Code, vim, and JetBrains, over HTTPS or SSH. |
| 116 | +- Coder is not an online IDE. |
| 117 | + - Coder supports common editors, such as VS Code, vim, and JetBrains, |
| 118 | + all over HTTPS or SSH. |
98 | 119 |
|
99 |
| -- Coder is not a collaboration platform. You can use git and dedicated IDE |
| 120 | +- Coder is not a collaboration platform. |
| 121 | + - You can use Git with your favorite Git platform and dedicated IDE |
100 | 122 | extensions for pull requests, code reviews, and pair programming.
|
101 | 123 |
|
102 |
| -- Coder is not a SaaS/fully-managed offering. You must host |
103 |
| - Coder on a cloud service (AWS, Azure, GCP) or your private data center. |
| 124 | +- Coder is not a SaaS/fully-managed offering. |
| 125 | + - Coder is a [self-hosted](https://en.wikipedia.org/wiki/Self-hosting_(web_services)) |
| 126 | + solution. |
| 127 | + You must host Coder in a private data center or on a cloud service, such as |
| 128 | + AWS, Azure, or GCP. |
104 | 129 |
|
105 | 130 | ## Up next
|
106 | 131 |
|
|
0 commit comments