Skip to content

Commit 3469242

Browse files
EdwardAngertEdwardAngert
committed
edits to README
1 parent 6bf73a5 commit 3469242

File tree

1 file changed

+111
-84
lines changed

1 file changed

+111
-84
lines changed

‎docs/README.md

Lines changed: 111 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,116 +1,143 @@
1-
# About Coder
1+
# What is Coder
22

3-
<!-- Warning for docs contributors: The first route in manifest.json must be titled "About" for the static landing page to work correctly. -->
3+
Coder is a self-hosted, open source, cloud development environment that works
4+
with any cloud, IDE, OS, Git provider, and IDP.
45

5-
Coder is an open-source platform for creating and managing developer workspaces
6-
on your preferred clouds and servers.
6+
![Screenshots of Coder workspaces and connections](./images/hero-image.png)_Screenshots of Coder workspaces and connections_
77

8-
<p align="center">
9-
<img src="./images/hero-image.png">
10-
</p>
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.
1111

12-
By building on top of common development interfaces (SSH) and infrastructure
13-
tools (Terraform), Coder aims to make the process of **provisioning** and
14-
**accessing** remote workspaces approachable for organizations of various sizes
15-
and stages of cloud-native maturity.
12+
## IDE support
1613

17-
<blockquote class="warning">
18-
<p>
19-
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>.
20-
</p>
21-
</blockquote>
14+
![IDE icons](./images/ide-icons.svg)
2215

23-
## How it works
16+
You can use:
2417

25-
Coder workspaces are represented with Terraform, but no Terraform knowledge is
26-
required to get started. We have a
27-
[database](https://registry.coder.com/templates) of pre-made templates built
28-
into the product.
18+
- Any Web IDE, such as
2919

30-
<p align="center">
31-
<img src="./images/providers-compute.png">
32-
</p>
20+
- [code-server](https://github.com/coder/code-server)
21+
- [JetBrains Projector](https://github.com/JetBrains/projector-server)
22+
- [Jupyter](https://jupyter.org/)
23+
- And others
3324

34-
Coder workspaces don't stop at compute. You can add storage buckets, secrets,
35-
sidecars and whatever else Terraform lets you dream up.
25+
- Your existing remote development environment:
3626

37-
[Learn more about templates.](./admin/templates/index.md)
27+
- [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/)
28+
- [VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial)
29+
- [Emacs](./user-guides/workspace-access/emacs-tramp.md)
3830

39-
## IDE Support
31+
- A file sync such as [Mutagen](https://mutagen.io/)
4032

41-
You can use any [Web IDE](./admin/templates/extending-templates/web-ides.md)
42-
([code-server](https://github.com/coder/code-server),
43-
[projector](https://github.com/JetBrains/projector-server),
44-
[Jupyter](https://jupyter.org), etc.),
45-
[JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/),
46-
[VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial) or even
47-
a file sync such as [mutagen](https://mutagen.io/).
33+
## Why remote development
4834

49-
<p align="center">
50-
<img src="./images/ide-icons.svg" height=72>
51-
</p>
35+
Remote development offers several benefits for users and administrators, including:
5236

53-
## Why remote development
37+
- **Increased speed**
38+
39+
- Server-grade cloud hardware speeds up operations in software development, from
40+
loading the IDE to compiling and building code, and running large workloads
41+
such as those for monolith or microservice applications.
42+
43+
- **Easier environment management**
44+
45+
- Built-in infrastructure tools such as Terraform, nix, Docker, Dev Containers, and others make it easier to onboard developers with consistent environments.
5446

55-
Migrating from local developer machines to workspaces hosted by cloud services
56-
is an
57-
[increasingly common solution for developers](https://blog.alexellis.io/the-internet-is-my-computer/)
58-
and
59-
[organizations alike](https://slack.engineering/development-environments-at-slack).
60-
There are several benefits, including:
47+
- **Increased security**
6148

62-
- **Increased speed:** Server-grade compute speeds up operations in software
63-
development, such as IDE loading, code compilation and building, and the
64-
running of large workloads (such as those for monolith or microservice
65-
applications)
49+
- Centralize source code and other data onto private servers or cloud services instead of local developers' machines.
50+
- Manage users and groups with [SSO](./admin/users/oidc-auth.md) and [Role-based access controlled (RBAC)](./admin/users/groups-roles#roles).
6651

67-
- **Easier environment management:** Tools such as Terraform, nix, Docker,
68-
devcontainers, and so on make developer onboarding and the troubleshooting of
69-
development environments easier
52+
- **Improved compatibility**
7053

71-
- **Increase security:** Centralize source code and other data onto private
72-
servers or cloud services instead of local developer machines
54+
- Remote workspaces can share infrastructure configurations with other
55+
development, staging, and production environments, reducing configuration
56+
drift.
7357

74-
- **Improved compatibility:** Remote workspaces share infrastructure
75-
configuration with other development, staging, and production environments,
76-
reducing configuration drift
58+
- **Improved accessibility**
59+
- Connect to remote workspaces via browser-based IDEs or remote IDE
60+
extensions to enable developers regardless of the device they use, whether
61+
it's their main device, a lightweight laptop, Chromebook, or iPad.
7762

78-
- **Improved accessibility:** Devices such as lightweight notebooks,
79-
Chromebooks, and iPads can connect to remote workspaces via browser-based IDEs
80-
or remote IDE extensions
63+
Read more about why organizations and engineers are moving to remote
64+
development on [our blog](https://coder.com/blog), the
65+
[Slack engineering blog](https://slack.engineering/development-environments-at-slack),
66+
or from [OpenFaaS's Alex Ellis](https://blog.alexellis.io/the-internet-is-my-computer/).
8167

8268
## Why Coder
8369

84-
The key difference between Coder OSS and other remote IDE platforms is the added
85-
layer of infrastructure control. This additional layer allows admins to:
70+
The key difference between Coder and other remote IDE platforms is the added
71+
layer of infrastructure control.
72+
This additional layer allows admins to:
8673

87-
- Support ARM, Windows, Linux, and macOS workspaces
88-
- Modify pod/container specs (e.g., adding disks, managing network policies,
89-
setting/updating environment variables)
90-
- Use VM/dedicated workspaces, developing with Kernel features (no container
91-
knowledge required)
74+
- Simultaneously support ARM, Windows, Linux, and macOS workspaces.
75+
- Modify pod/container specs, such as adding disks, managing network policies, or
76+
setting/updating environment variables.
77+
- Use VM or dedicated workspaces, developing with Kernel features (no container
78+
knowledge required).
9279
- Enable persistent workspaces, which are like local machines, but faster and
93-
hosted by a cloud service
80+
hosted by a cloud service.
81+
82+
## How much does it cost?
83+
84+
Coder is free and open source under
85+
[GNU Affero General Public License v3.0](https://github.com/coder/coder/blob/main/LICENSE).
86+
All developer productivity features are included in the Open Source version of
87+
Coder.
88+
A [Premium license is available](https://coder.com/pricing#compare-plans) for enhanced
89+
support options and custom deployments.
90+
91+
## How does Coder work
92+
93+
Coder workspaces are represented with Terraform, but you don't need to know
94+
Terraform to get started.
95+
We have a [database of production-ready templates](https://registry.coder.com/templates)
96+
for use with AWS EC2, Azure, Google Cloud, Kubernetes, and more.
97+
98+
![Providers and compute environments](./images/providers-compute.png)_Providers and compute environments_
99+
100+
Coder workspaces can be used for more than just compute.
101+
You can use Terraform to add storage buckets, secrets, sidecars,
102+
[and more](https://developer.hashicorp.com/terraform/tutorials).
103+
104+
Visit the [templates documentation](./admin/templates/index.md) to learn more.
105+
106+
## What Coder is not
107+
108+
- Coder is not an infrastructure as code (IaC) platform.
109+
110+
- Terraform is the first IaC _provisioner_ in Coder, allowing Coder admins to
111+
define Terraform resources as Coder workspaces.
112+
113+
- Coder is not a DevOps/CI platform.
114+
115+
- Coder workspaces can be configured to follow best practices for
116+
cloud-service-based workloads, but Coder is not responsible for how you
117+
define or deploy the software you write.
118+
119+
- Coder is not an online IDE.
120+
121+
- Coder supports common editors, such as VS Code, vim, and JetBrains,
122+
all over HTTPS or SSH.
94123

95-
Coder includes
96-
[production-ready templates](https://registry.coder.com/templates) for use with
97-
AWS EC2, Azure, Google Cloud, Kubernetes, and more.
124+
- Coder is not a collaboration platform.
98125

99-
## What Coder is _not_
126+
- You can use Git with your favorite Git platform and dedicated IDE
127+
extensions for pull requests, code reviews, and pair programming.
100128

101-
- Coder is not an infrastructure as code (IaC) platform. Terraform is the first
102-
IaC _provisioner_ in Coder, allowing Coder admins to define Terraform
103-
resources as Coder workspaces.
129+
- Coder is not a SaaS/fully-managed offering.
130+
- Coder is a [self-hosted](<https://en.wikipedia.org/wiki/Self-hosting_(web_services)>)
131+
solution.
132+
You must host Coder in a private data center or on a cloud service, such as
133+
AWS, Azure, or GCP.
104134

105-
- Coder is not a DevOps/CI platform. Coder workspaces can follow best practices
106-
for cloud service-based workloads, but Coder is not responsible for how you
107-
define or deploy the software you write.
135+
## Using Coder v1?
108136

109-
- Coder is not an online IDE. Instead, Coder supports common editors, such as VS
110-
Code, vim, and JetBrains, over HTTPS or SSH.
137+
If you're a Coder v1 customer, view [the v1 documentation](https://coder.com/docs/v1)
138+
or [the v2 migration guide and FAQ](https://coder.com/docs/v1/guides/v2-faq).
111139

112-
- Coder is not a collaboration platform. You can use git and dedicated IDE
113-
extensions for pull requests, code reviews, and pair programming.
140+
## Up next
114141

115-
- Coder is not a SaaS/fully-managed offering. You must host Coder on a cloud
116-
service (AWS, Azure, GCP) or your private data center.
142+
- Learn about [Templates](./admin/templates/index.md)
143+
- [Install Coder](./install/index.md)

0 commit comments

Comments
 (0)