mirror of
https://github.com/coder/coder.git
synced 2026-06-02 20:48:20 +00:00
Joe Previte
b6899e2c18
* docs: move docs table of contents to docs/index.md * docs: move how it works and IDE support to about.md * docs: move readme steps to walkthrough * docs: slim down readme * refactor: walkthrough -> quickstart * docs: minor edits
88 lines
4.4 KiB
Markdown
88 lines
4.4 KiB
Markdown
# Coder
|
|
|
|
[](https://github.com/coder/coder/discussions)
|
|
[](https://discord.gg/coder)
|
|
[](https://twitter.com/coderhq)
|
|
[](https://codecov.io/gh/coder/coder)
|
|
|
|
Coder creates remote development machines so your team can develop from anywhere.
|
|
|
|
<p align="center">
|
|
<img src="./docs/images/hero-image.png">
|
|
</p>
|
|
|
|
**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
|
|
|
|
**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
|
|
|
|
## Getting Started
|
|
|
|
> **Note**:
|
|
> Coder is in an alpha state. [Report issues here](https://github.com/coder/coder/issues/new).
|
|
|
|
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. Use our [quickstart guide](./docs/quickstart.md) for a full walkthrough.
|
|
|
|
## Documentation
|
|
|
|
Visit our docs [here](./docs/index.md).
|
|
|
|
## 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 |
|
|
|
|
---
|
|
|
|
_Last updated: 5/27/22_
|
|
|
|
## Community and Support
|
|
|
|
Join our community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq)!
|
|
|
|
[Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose)
|
|
|
|
## Contributing
|
|
|
|
Read the [contributing docs](./docs/CONTRIBUTING.md).
|
|
|
|
Find our list of contributors [here](./docs/CONTRIBUTORS.md).
|