mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
165 lines
6.8 KiB
Markdown
165 lines
6.8 KiB
Markdown
# Coder
|
|
|
|
[](https://github.com/coder/coder/discussions)
|
|
[](https://discord.gg/coder)
|
|
[](https://twitter.com/coderhq)
|
|
[](https://codecov.io/gh/coder/coder)
|
|
|
|
## Run Coder *now*
|
|
|
|
```curl -L https://coder.com/install.sh | sh```
|
|
|
|
## What Coder does
|
|
Coder creates remote development machines so you can develop your code from anywhere. #coder
|
|
|
|
> **Note**:
|
|
> Coder is in an alpha state, but any serious bugs are P1 for us so [please report them](https://github.com/coder/coder/issues/new/choose).
|
|
|
|
<p align="center">
|
|
<img src="./docs/images/hero-image.png">
|
|
</p>
|
|
|
|
**Code more**
|
|
|
|
- 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
|
|
|
|
**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.
|
|
|
|
<p align="center">
|
|
<img src="./docs/images/providers-compute.png">
|
|
</p>
|
|
|
|
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
|
|
|
|
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
|
|
|
|
There are a few ways to install Coder: [install script](./docs/install.md#installsh) (macOS, Linux), [docker-compose](./docs/install.md#docker-compose), or [manually](./docs/install.md#manual) via the latest release (macOS, Windows, and Linux).
|
|
|
|
If you use the install script, you can preview what occurs during the install process:
|
|
|
|
```sh
|
|
curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run
|
|
```
|
|
|
|
To install, run:
|
|
|
|
```sh
|
|
curl -fsSL https://coder.com/install.sh | sh
|
|
```
|
|
|
|
Once installed, you can run a temporary deployment in dev mode (all data is in-memory and destroyed on exit):
|
|
|
|
```sh
|
|
coder server --dev
|
|
```
|
|
|
|
Use `coder --help` to get a complete list of flags and environment variables.
|
|
|
|
## Creating your first template and workspace
|
|
|
|
In a new terminal window, run the following to copy a sample template:
|
|
|
|
```bash
|
|
coder templates init
|
|
```
|
|
|
|
Follow the CLI instructions to modify and create the template specific for your
|
|
usage (e.g., a template to **Develop in Linux on Google Cloud**).
|
|
|
|
Create a workspace using your template:
|
|
|
|
```bash
|
|
coder create --template="yourTemplate" <workspaceName>
|
|
```
|
|
|
|
Connect to your workspace via SSH:
|
|
|
|
```bash
|
|
coder ssh <workspaceName>
|
|
```
|
|
|
|
## Modifying templates
|
|
|
|
You can edit the Terraform template using a sample template:
|
|
|
|
```sh
|
|
coder templates init
|
|
cd gcp-linux/
|
|
vim main.tf
|
|
coder templates update gcp-linux
|
|
```
|
|
|
|
## Documentation
|
|
|
|
- [About Coder](./docs/about.md#about-coder)
|
|
- [Why remote development](./docs/about.md#why-remote-development)
|
|
- [Why Coder](./docs/about.md#why-coder)
|
|
- [What Coder is not](./docs/about.md#what-coder-is-not)
|
|
- [Comparison: Coder vs. [product]](./docs/about.md#comparison)
|
|
- [Templates](./docs/templates.md)
|
|
- [Manage templates](./docs/templates.md#manage-templates)
|
|
- [Persistent and ephemeral
|
|
resources](./docs/templates.md#persistent-and-ephemeral-resources)
|
|
- [Parameters](./docs/templates.md#parameters)
|
|
- [Workspaces](./docs/workspaces.md)
|
|
- [Create workspaces](./docs/workspaces.md#create-workspaces)
|
|
- [Connect with SSH](./docs/workspaces.md#connect-with-ssh)
|
|
- [Editors and IDEs](./docs/workspaces.md#editors-and-ides)
|
|
- [Workspace lifecycle](./docs/workspaces.md#workspace-lifecycle)
|
|
- [Updating workspaces](./docs/workspaces.md#updating-workspaces)
|
|
|
|
## Community
|
|
|
|
Join the community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq) #coder!
|
|
|
|
[Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose)
|
|
|
|
## Comparison
|
|
|
|
Please file [an issue](https://github.com/coder/coder/issues/new) if any information is out of date. Also refer to: [What Coder is not](./docs/about.md#what-coder-is-not).
|
|
|
|
| Tool | Type | Delivery Model | Cost | Environments |
|
|
| :---------------------------------------------------------- | :------- | :----------------- | :---------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| [Coder](https://github.com/coder/coder) | Platform | OSS + Self-Managed | Pay your cloud | All [Terraform](https://www.terraform.io/registry/providers) resources, all clouds, multi-architecture: Linux, Mac, Windows, containers, VMs, amd64, arm64 |
|
|
| [code-server](https://github.com/cdr/code-server) | Web IDE | OSS + Self-Managed | Pay your cloud | Linux, Mac, Windows, containers, VMs, amd64, arm64 |
|
|
| [Coder (Classic)](https://coder.com/docs) | Platform | Self-Managed | Pay your cloud + license fees | Kubernetes Linux Containers |
|
|
| [GitHub Codespaces](https://github.com/features/codespaces) | Platform | SaaS | 2x Azure Compute | Linux containers |
|
|
|
|
---
|
|
|
|
_As of 5/27/22_
|
|
|
|
## Contributing
|
|
|
|
Read the [contributing docs](./docs/CONTRIBUTING.md).
|
|
|
|
Find our list of contributors [here](./docs/CONTRIBUTORS.md).
|