Files
coder/README.md
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

133 lines
6.9 KiB
Markdown
Raw Normal View History

<!-- markdownlint-disable MD041 -->
2023-01-29 19:45:00 -06:00
<div align="center">
<a href="https://coder.com#gh-light-mode-only">
<img src="./docs/images/logo-black.png" alt="Coder Logo Light" style="width: 128px">
</a>
<a href="https://coder.com#gh-dark-mode-only">
<img src="./docs/images/logo-white.png" alt="Coder Logo Dark" style="width: 128px">
</a>
2022-01-03 18:54:27 -08:00
2023-01-29 19:45:00 -06:00
<h1>
Self-Hosted Cloud Development Environments
2023-01-29 19:45:00 -06:00
</h1>
<a href="https://coder.com#gh-light-mode-only">
<img src="./docs/images/banner-black.png" alt="Coder Banner Light" style="width: 650px">
</a>
<a href="https://coder.com#gh-dark-mode-only">
<img src="./docs/images/banner-white.png" alt="Coder Banner Dark" style="width: 650px">
</a>
2023-01-29 19:45:00 -06:00
<br>
<br>
2024-11-04 09:55:40 -08:00
[Quickstart](#quickstart) | [Docs](https://coder.com/docs) | [Why Coder](https://coder.com/why) | [Premium](https://coder.com/pricing#compare-plans)
2023-01-29 19:45:00 -06:00
[![discord](https://img.shields.io/discord/747933592273027093?label=discord)](https://discord.gg/coder)
2023-02-01 13:14:49 -06:00
[![release](https://img.shields.io/github/v/release/coder/coder)](https://github.com/coder/coder/releases/latest)
2023-01-29 19:45:00 -06:00
[![godoc](https://pkg.go.dev/badge/github.com/coder/coder.svg)](https://pkg.go.dev/github.com/coder/coder)
[![Go Report Card](https://goreportcard.com/badge/github.com/coder/coder/v2)](https://goreportcard.com/report/github.com/coder/coder/v2)
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9511/badge)](https://www.bestpractices.dev/projects/9511)
2024-11-04 09:55:40 -08:00
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/coder/coder/badge)](https://scorecard.dev/viewer/?uri=github.com%2Fcoder%2Fcoder)
2023-01-29 19:45:00 -06:00
[![license](https://img.shields.io/github/license/coder/coder)](./LICENSE)
2022-01-03 18:52:07 +00:00
2023-01-29 19:45:00 -06:00
</div>
[Coder](https://coder.com) enables organizations to set up development environments in their public or private cloud infrastructure. Cloud development environments are defined with Terraform, connected through a secure high-speed Wireguard® tunnel, and automatically shut down when not used to save on costs. Coder gives engineering teams the flexibility to use the cloud for workloads most beneficial to them.
2023-01-29 19:45:00 -06:00
- Define cloud development environments in Terraform
2023-01-29 19:45:00 -06:00
- EC2 VMs, Kubernetes Pods, Docker Containers, etc.
- Automatically shutdown idle resources to save on costs
- Onboard developers in seconds instead of days
2022-11-16 20:15:33 +10:00
2022-05-24 19:40:57 -05:00
<p align="center">
<img src="./docs/images/hero-image.png" alt="Coder Hero Image">
2022-05-24 19:40:57 -05:00
</p>
2022-05-05 20:09:27 -05:00
2023-01-29 19:45:00 -06:00
## Quickstart
2022-05-24 19:40:57 -05:00
The most convenient way to try Coder is to install it on your local machine and experiment with provisioning cloud development environments using Docker (works on Linux, macOS, and Windows).
2022-05-24 19:40:57 -05:00
```shell
2023-01-29 19:45:00 -06:00
# First, install Coder
curl -L https://coder.com/install.sh | sh
# Start the Coder server (caches data in ~/.cache/coder)
coder server
2024-03-18 14:40:47 +01:00
# Navigate to http://localhost:3000 to create your initial user,
# create a Docker template and provision a workspace
2023-01-29 19:45:00 -06:00
```
## Install
2022-10-26 00:19:54 +10:00
The easiest way to install Coder is to use our
[install script](https://github.com/coder/coder/blob/main/install.sh) for Linux
and macOS. For Windows, use the latest `..._installer.exe` file from GitHub
Releases.
```shell
2022-06-19 15:49:42 -05:00
curl -L https://coder.com/install.sh | sh
2022-06-01 14:15:09 -05:00
```
2024-03-18 14:40:47 +01:00
You can run the install script with `--dry-run` to see the commands that will be used to install without executing them. Run the install script with `--help` for additional flags.
2022-06-19 15:49:42 -05:00
> See [install](https://coder.com/docs/install) for additional methods.
2022-06-19 15:49:42 -05:00
2024-03-18 14:40:47 +01:00
Once installed, you can start a production deployment with a single command:
```shell
# Automatically sets up an external access URL on *.try.coder.app
2022-10-07 08:05:56 -05:00
coder server
2022-10-17 19:24:49 -05:00
# Requires a PostgreSQL instance (version 13 or higher) and external access URL
coder server --postgres-url <url> --access-url <url>
2022-06-01 14:15:09 -05:00
```
Use `coder --help` to get a list of flags and environment variables. Use our [install guides](https://coder.com/docs/install) for a complete walkthrough.
2022-04-26 12:10:50 -05:00
## Documentation
Browse our docs [here](https://coder.com/docs) or visit a specific section below:
- [**Templates**](https://coder.com/docs/templates): Templates are written in Terraform and describe the infrastructure for workspaces
- [**Workspaces**](https://coder.com/docs/workspaces): Workspaces contain the IDEs, dependencies, and configuration information needed for software development
- [**IDEs**](https://coder.com/docs/ides): Connect your existing editor to a workspace
- [**Administration**](https://coder.com/docs/admin): Learn how to operate Coder
- [**Premium**](https://coder.com/pricing#compare-plans): Learn about our paid features built for large teams
2024-03-18 14:40:47 +01:00
## Support
2023-01-29 19:45:00 -06:00
Feel free to [open an issue](https://github.com/coder/coder/issues/new) if you have questions, run into bugs, or have a feature request.
[Join our Discord](https://discord.gg/coder) to provide feedback on in-progress features and chat with the community using Coder!
2024-03-18 14:40:47 +01:00
## Integrations
2022-05-27 11:34:03 -05:00
We are always working on new integrations. Please feel free to open an issue and ask for an integration. Contributions are welcome in any official or community repositories.
2022-05-27 11:34:03 -05:00
2023-01-29 19:45:00 -06:00
### Official
2022-05-27 11:34:03 -05:00
2023-01-29 19:45:00 -06:00
- [**VS Code Extension**](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote): Open any Coder workspace in VS Code with a single click
2025-05-29 17:56:44 -07:00
- [**JetBrains Toolbox Plugin**](https://plugins.jetbrains.com/plugin/26968-coder): Open any Coder workspace from JetBrains Toolbox with a single click
- [**JetBrains Gateway Plugin**](https://plugins.jetbrains.com/plugin/19620-coder): Open any Coder workspace in JetBrains Gateway with a single click
2024-03-18 14:40:47 +01:00
- [**Dev Container Builder**](https://github.com/coder/envbuilder): Build development environments using `devcontainer.json` on Docker, Kubernetes, and OpenShift
2025-05-29 17:56:44 -07:00
- [**Coder Registry**](https://registry.coder.com): Build and extend development environments with common use-cases
2024-03-18 14:40:47 +01:00
- [**Kubernetes Log Stream**](https://github.com/coder/coder-logstream-kube): Stream Kubernetes Pod events to the Coder startup logs
2023-01-29 19:45:00 -06:00
- [**Self-Hosted VS Code Extension Marketplace**](https://github.com/coder/code-marketplace): A private extension marketplace that works in restricted or airgapped networks integrating with [code-server](https://github.com/coder/code-server).
- [**Setup Coder**](https://github.com/marketplace/actions/setup-coder): An action to setup coder CLI in GitHub workflows.
2022-05-27 11:34:03 -05:00
2023-01-29 19:45:00 -06:00
### Community
- [**Provision Coder with Terraform**](https://github.com/ElliotG/coder-oss-tf): Provision Coder on Google GKE, Azure AKS, AWS EKS, DigitalOcean DOKS, IBMCloud K8s, OVHCloud K8s, and Scaleway K8s Kapsule with Terraform
2024-03-18 14:40:47 +01:00
- [**Coder Template GitHub Action**](https://github.com/marketplace/actions/update-coder-template): A GitHub Action that updates Coder templates
## Contributing
We are always happy to see new contributors to Coder. If you are new to the Coder codebase, we have
[a guide on how to get started](https://coder.com/docs/CONTRIBUTING). We'd love to see your
contributions!
2024-05-22 12:01:29 -05:00
## Hiring
Apply [here](https://jobs.ashbyhq.com/coder?utm_source=github&utm_medium=readme&utm_campaign=unknown) if you're interested in joining our team.