Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit cecc47a

Browse files
committed
README in root
1 parent 06266a8 commit cecc47a

File tree

1 file changed

+117
-0
lines changed

1 file changed

+117
-0
lines changed

docs/README.md

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
# About Coder
2+
3+
Coder is an open-source platform for creating and managing developer workspaces
4+
on your preferred clouds and servers.
5+
6+
<p align="center">
7+
<img src="./images/hero-image.png">
8+
</p>
9+
10+
By building on top of common development interfaces (SSH) and infrastructure
11+
tools (Terraform), Coder aims to make the process of **provisioning** and
12+
**accessing** remote workspaces approachable for organizations of various sizes
13+
and stages of cloud-native maturity.
14+
15+
<blockquote class="warning">
16+
<p>
17+
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>.
18+
</p>
19+
</blockquote>
20+
21+
## How it works
22+
23+
Coder workspaces are represented with Terraform, but no Terraform knowledge is
24+
required to get started. We have a database of pre-made templates built into the
25+
product.
26+
27+
<p align="center">
28+
<img src="./images/providers-compute.png">
29+
</p>
30+
31+
Coder workspaces don't stop at compute. You can add storage buckets, secrets,
32+
sidecars and whatever else Terraform lets you dream up.
33+
34+
[Learn more about managing infrastructure.](../admin/templates/index.md)
35+
36+
## IDE Support
37+
38+
You can use any Web IDE ([code-server](https://github.com/coder/code-server),
39+
[projector](https://github.com/JetBrains/projector-server),
40+
[Jupyter](https://jupyter.org/), etc.),
41+
[JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/),
42+
[VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial) or even
43+
a file sync such as [mutagen](https://mutagen.io/).
44+
45+
<p align="center">
46+
<img src="./images/ide-icons.svg" height=72>
47+
</p>
48+
49+
## Why remote development
50+
51+
Migrating from local developer machines to workspaces hosted by cloud services
52+
is an
53+
[increasingly common solution for developers](https://blog.alexellis.io/the-internet-is-my-computer/)
54+
and
55+
[organizations alike](https://slack.engineering/development-environments-at-slack).
56+
There are several benefits, including:
57+
58+
- **Increased speed:** Server-grade compute speeds up operations in software
59+
development, such as IDE loading, code compilation and building, and the
60+
running of large workloads (such as those for monolith or microservice
61+
applications)
62+
63+
- **Easier environment management:** Tools such as Terraform, nix, Docker,
64+
devcontainers, and so on make developer onboarding and the troubleshooting of
65+
development environments easier
66+
67+
- **Increase security:** Centralize source code and other data onto private
68+
servers or cloud services instead of local developer machines
69+
70+
- **Improved compatibility:** Remote workspaces share infrastructure
71+
configuration with other development, staging, and production environments,
72+
reducing configuration drift
73+
74+
- **Improved accessibility:** Devices such as lightweight notebooks,
75+
Chromebooks, and iPads can connect to remote workspaces via browser-based IDEs
76+
or remote IDE extensions
77+
78+
## Why Coder
79+
80+
The key difference between Coder OSS and other remote IDE platforms is the added
81+
layer of infrastructure control. This additional layer allows admins to:
82+
83+
- Support ARM, Windows, Linux, and macOS workspaces
84+
- Modify pod/container specs (e.g., adding disks, managing network policies,
85+
setting/updating environment variables)
86+
- Use VM/dedicated workspaces, developing with Kernel features (no container
87+
knowledge required)
88+
- Enable persistent workspaces, which are like local machines, but faster and
89+
hosted by a cloud service
90+
91+
Coder includes
92+
[production-ready templates](https://github.com/coder/coder/tree/main/examples/templates)
93+
for use with AWS EC2, Azure, Google Cloud, Kubernetes, and more.
94+
95+
## What Coder is _not_
96+
97+
- Coder is not an infrastructure as code (IaC) platform. Terraform is the first
98+
IaC _provisioner_ in Coder, allowing Coder admins to define Terraform
99+
resources as Coder workspaces.
100+
101+
- Coder is not a DevOps/CI platform. Coder workspaces can follow best practices
102+
for cloud service-based workloads, but Coder is not responsible for how you
103+
define or deploy the software you write.
104+
105+
- Coder is not an online IDE. Instead, Coder supports common editors, such as VS
106+
Code, vim, and JetBrains, over HTTPS or SSH.
107+
108+
- Coder is not a collaboration platform. You can use git and dedicated IDE
109+
extensions for pull requests, code reviews, and pair programming.
110+
111+
- Coder is not a SaaS/fully-managed offering. You must host Coder on a cloud
112+
service (AWS, Azure, GCP) or your private data center.
113+
114+
## Up next
115+
116+
- Learn about [Templates](../admin/templates/index.md)
117+
- [Install Coder](../install/index.md)

0 commit comments

Comments
 (0)