Coder Enterprise Hub

Welcome to the Coder Enterprise hub. You'll find comprehensive guides and documentation to help you start working with Coder as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Changelog

Coder Enterprise allows you to add services, which are "sidecar" containers that run alongside your primary development environment.

Configuring a service will make it will be available to all users in your organization. All users get their own instance of the service.

Before You Proceed

Creating a service is similar to importing an image into Coder. Before proceeding, be sure that your Coder deployment can access a registry from which it can pull images.

Adding a Service

To add a new service, go to Services in the top navigation bar and click New Service.

Create a Service

You'll be asked to provide the following basic information:

  • Service Name: The name for your service
  • Service Description: (Optional) A description of what your service is/what it does:
  • Image: The image to be pulled
  • Tag: The specific image to you want to be pulled

If your service requires a privileged container, check the box indicating this.

You can click Create to proceed, though you may want to set overrides, create environment variables, or set your volume mounts as well.

Overrides

If you want to override the way to start your image, you can do so by providing the Dockerfile entrypoint. You can also provide as many command arguments as necessary to the entry point.

Environment Variables

You can create environment variables that are injected into the service's container. These variables can change your application's behavior, or they can be used to store the information you don't want to be saved in the image (e.g., database URIs or API keys).

To create an environment variable, provide the name you want to be used as the key and the value you want to store with the key. You can create as many variables as you'd like.

Volume Mounts

If you would like your service to create a storage directory that persists through rebuilds, you can define the volume used here. (Please note that the service will have access to the home volume of the primary container.) You'll need to provide:

  • A name for the volume
  • The path to the volume
  • How large the volume should be

Updated about a month ago


Services


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.