coder
moduleThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
README¶
Coder 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.
- Define cloud development environments in Terraform
- EC2 VMs, Kubernetes Pods, Docker Containers, etc.
- Automatically shutdown idle resources to save on costs
- Onboard developers in seconds instead of days
Quickstart
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).
# First, install Codercurl -L https://coder.com/install.sh | sh# Start the Coder server (caches data in ~/.cache/coder)coder server# Navigate to http://localhost:3000 to create your initial user,# create a Docker template and provision a workspace
Install
The easiest way to install Coder is to use ourinstall script for Linuxand macOS. For Windows, use the latest..._installer.exe
file from GitHubReleases.
curl -L https://coder.com/install.sh | sh
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.
Seeinstall for additional methods.
Once installed, you can start a production deployment with a single command:
# Automatically sets up an external access URL on *.try.coder.appcoder server# Requires a PostgreSQL instance (version 13 or higher) and external access URLcoder server --postgres-url <url> --access-url <url>
Usecoder --help
to get a list of flags and environment variables. Use ourinstall guides for a complete walkthrough.
Documentation
Browse our docshere or visit a specific section below:
- Templates: Templates are written in Terraform and describe the infrastructure for workspaces
- Workspaces: Workspaces contain the IDEs, dependencies, and configuration information needed for software development
- IDEs: Connect your existing editor to a workspace
- Administration: Learn how to operate Coder
- Premium: Learn about our paid features built for large teams
Support
Feel free toopen an issue if you have questions, run into bugs, or have a feature request.
Join our Discord to provide feedback on in-progress features and chat with the community using Coder!
Integrations
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.
Official
- VS Code Extension: Open any Coder workspace in VS Code with a single click
- JetBrains Gateway Extension: Open any Coder workspace in JetBrains Gateway with a single click
- Dev Container Builder: Build development environments using
devcontainer.json
on Docker, Kubernetes, and OpenShift - Module Registry: Extend development environments with common use-cases
- Kubernetes Log Stream: Stream Kubernetes Pod events to the Coder startup logs
- Self-Hosted VS Code Extension Marketplace: A private extension marketplace that works in restricted or airgapped networks integrating withcode-server.
- Setup Coder: An action to setup coder CLI in GitHub workflows.
Community
- Provision Coder with Terraform: Provision Coder on Google GKE, Azure AKS, AWS EKS, DigitalOcean DOKS, IBMCloud K8s, OVHCloud K8s, and Scaleway K8s Kapsule with Terraform
- Coder Template GitHub Action: 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 havea guide on how to get started. We'd love to see yourcontributions!
Hiring
Applyhere if you're interested in joining our team.
Directories¶
Path | Synopsis |
---|---|
agentcontainers/acmock Package acmock is a generated GoMock package. | Package acmock is a generated GoMock package. |
agentcontainers/dcspec Package dcspec contains an automatically generated Devcontainer specification. | Package dcspec contains an automatically generated Devcontainer specification. |
agentcontainers/watcher Package watcher provides file system watching capabilities for the agent. | Package watcher provides file system watching capabilities for the agent. |
reaper Package reaper contains logic for reaping subprocesses. | Package reaper contains logic for reaping subprocesses. |
Package apiversion provides an API version type that can be used to validate compatibility between two API versions. | Package apiversion provides an API version type that can be used to validate compatibility between two API versions. |
resources This package is used for embedding .syso resource files into the binary during build and does not contain any code. | This package is used for embedding .syso resource files into the binary during build and does not contain any code. |
clilog Package clilog provides a fluent API for configuring structured logging. | Package clilog provides a fluent API for configuring structured logging. |
cmd | |
apidoc Package apidoc GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag | Package apidoc GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag |
autobuild Package autobuild contains logic for scheduling workspace builds in the background. | Package autobuild contains logic for scheduling workspace builds in the background. |
coderdtest/promhelp Package promhelp provides helper functions for asserting Prometheus metric values in unit tests. | Package promhelp provides helper functions for asserting Prometheus metric values in unit tests. |
cryptokeys Package cryptokeys provides an abstraction for fetching internally used cryptographic keys mainly for JWT signing and verification. | Package cryptokeys provides an abstraction for fetching internally used cryptographic keys mainly for JWT signing and verification. |
database Package database connects to external services for stateful storage. | Package database connects to external services for stateful storage. |
database/db2sdk Package db2sdk provides common conversion routines from database types to codersdk types | Package db2sdk provides common conversion routines from database types to codersdk types |
database/dbauthz Package dbauthz provides an authorization layer on top of the database. | Package dbauthz provides an authorization layer on top of the database. |
database/dbmetrics Code generated by coderd/database/gen/metrics. | Code generated by coderd/database/gen/metrics. |
database/dbmock Package dbmock is a generated GoMock package. | Package dbmock is a generated GoMock package. |
database/gentest Package gentest contains tests that are run at db generate time. | Package gentest contains tests that are run at db generate time. |
database/pubsub/psmock package psmock contains a mocked implementation of the pubsub.Pubsub interface for use in tests | package psmock contains a mocked implementation of the pubsub.Pubsub interface for use in tests |
httpapi/httpapiconstraints Package httpapiconstraints contain types that can be used and implemented across the application to return specific HTTP status codes without pulling in large dependency trees. | Package httpapiconstraints contain types that can be used and implemented across the application to return specific HTTP status codes without pulling in large dependency trees. |
httpmw/loggermw/loggermock Package loggermock is a generated GoMock package. | Package loggermock is a generated GoMock package. |
promoauth Package promoauth is for instrumenting oauth2 flows with prometheus metrics. | Package promoauth is for instrumenting oauth2 flows with prometheus metrics. |
rbac Code generated by typegen/main.go. | Code generated by typegen/main.go. |
rbac/regosql Package regosql converts rego queries into SQL WHERE clauses. | Package regosql converts rego queries into SQL WHERE clauses. |
rbac/regosql/sqltypes Package sqltypes contains the types used to convert rego queries into SQL. | Package sqltypes contains the types used to convert rego queries into SQL. |
runtimeconfig Package runtimeconfig contains logic for managing runtime configuration values stored in the database. | Package runtimeconfig contains logic for managing runtime configuration values stored in the database. |
schedule/cron package schedule provides utilities for managing template and workspace autostart and autostop schedules. | package schedule provides utilities for managing template and workspace autostart and autostop schedules. |
updatecheck Package updatecheck provides a mechanism for periodically checking for updates to Coder. | Package updatecheck provides a mechanism for periodically checking for updates to Coder. |
util/lazy Package lazy provides a lazy value implementation. | Package lazy provides a lazy value implementation. |
util/ptr Package ptr contains some utility methods related to pointers. | Package ptr contains some utility methods related to pointers. |
util/tz Package tz includes utilities for cross-platform timezone/location detection. | Package tz includes utilities for cross-platform timezone/location detection. |
workspaceapps/appurl Package appurl handles all parsing/validation/etc around application URLs. | Package appurl handles all parsing/validation/etc around application URLs. |
wsbuilder Package wsbuilder provides the Builder object, which encapsulates the common business logic of inserting a new workspace build into the database. | Package wsbuilder provides the Builder object, which encapsulates the common business logic of inserting a new workspace build into the database. |
Code generated by typegen/main.go. | Code generated by typegen/main.go. |
enterprise | |
coderd/httpmw Package httpmw contains middleware for HTTP handlers. | Package httpmw contains middleware for HTTP handlers. |
coderd/license Package license provides the license parsing and validation logic for Coderd. | Package license provides the license parsing and validation logic for Coderd. |
dbcrypt Package dbcrypt provides a database.Store wrapper that encrypts/decrypts values stored at rest in the database. | Package dbcrypt provides a database.Store wrapper that encrypts/decrypts values stored at rest in the database. |
scaletest | |
Package gorules defines custom lint rules for ruleguard. | Package gorules defines custom lint rules for ruleguard. |
embedded-pg Start an embedded postgres database on port 5432. | Start an embedded postgres database on port 5432. |
tailnettest Package tailnettest is a generated GoMock package. | Package tailnettest is a generated GoMock package. |