coder

module
v0.26.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 12, 2023 License: AGPL-3.0

README

Self-Hosted Remote Development Environments



Quickstart | Docs | Why Coder | Enterprise

discord codecov release godoc Go Report Card license

Coder enables organizations to set up development environments in the cloud. Environments are defined with Terraform, connected through a secure high-speed Wireguard® tunnel, and are automatically shut down when not in use to save on costs. Coder gives engineering teams the flexibility to use the cloud for workloads that are most beneficial to them.

  • Define 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 development environments using Docker (works on Linux, macOS, and Windows).

# First, install Coder
curl -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 our install script for Linux and macOS. For Windows, use the latest ..._installer.exe file from GitHub Releases.

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. You can modify the installation process by including flags. Run the install script with --help for reference.

See install for additional methods.

Once installed, you can start a production deployment1 with a single command:

# Automatically sets up an external access URL on *.try.coder.app
coder server

# Requires a PostgreSQL instance (version 13 or higher) and external access URL
coder server --postgres-url <url> --access-url <url>

1 For production deployments, set up an external PostgreSQL instance for reliability.

Use coder --help to get a list of flags and environment variables. Use our install guides for a full walkthrough.

Documentation

Browse our docs here 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
  • Enterprise: Learn about our paid features built for large teams

Community and Support

Feel free to open 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!

Contributing

Contributions are welcome! Read the contributing docs to get started.

Find our list of contributors here.

We are always working on new integrations. Feel free to open an issue to request an integration. Contributions are welcome in any official or community repositories.

Official

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 GitHub Action: A GitHub Action that updates Coder templates
  • Various Templates: Hetzner Cloud, Docker in Docker, and other templates the community has built.

Directories

Path Synopsis
reaper
Package reaper contains logic for reaping subprocesses.
Package reaper contains logic for reaping subprocesses.
cli
clibase
Package clibase offers an all-in-one solution for a highly configurable CLI application.
Package clibase offers an all-in-one solution for a highly configurable CLI application.
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.
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.
rbac
Code generated by rbacgen/main.go.
Code generated by rbacgen/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.
schedule
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/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.
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.
wsconncache
Package wsconncache caches workspace agent connections by UUID.
Package wsconncache caches workspace agent connections by UUID.
enterprise
cli
pty
scaletest
Package gorules defines custom lint rules for ruleguard.
Package gorules defines custom lint rules for ruleguard.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL