Whenever you log into Coder, you'll see the Workspace page.

If this is your first time using Coder, you'll see a Create Workspace button in the middle of your screen; otherwise, you'll see a list of your existing workspaces.

To create a workspace, launch the creation dialog by clicking New Workspace in the top-right. If you'd like to create a new workspace based on a template, click the drop-down arrow next to New Workspace and select New workspace from template.

Create a workspace

When prompted, provide the following information:

Workspace nameA friendly name for your workspace
Image sourceThe source of your image; leave as Existing in most cases. You can also import a new image if your site manager has imported a registry or select a packaged image provided by Coder if your site manager has enabled the automatic importing of the Default Registry.
ImageThe Docker image you want to use as the base for your workspace
TagThe version of the image you want to use
Workspace providerThe Kubernetes cluster to which your workspace will be deployed. Default: built-in

Coder offers several advanced settings that allow you to customize your workspace. You can choose to run your workspace as a container-based virtual machine, provide a dotfiles URI for personalization, and set your resource allocation.

Workspace setup advanced settings

Run as container-based virtual machineEnable this to allow the running of system-level applications like Docker, Systemd, and Kubernetes; this provides a VM-like experience with the footprint of a container
Dotfiles Git URIThe link to your Dotfiles repo; Coder will apply the settings prescribed every time your workspace rebuilds
CPU coresThe number of CPU cores you'd like for your workspace
MemoryThe amount of memory you'd like for your workspace
DiskThe amount of storage space you'd like for your workspace
GPUThe number of GPUs you want allocated to your workspace
Auto-startWhether you want your workspace to turn on automatically at a specific time (you can set the auto-start time in User Preferences.
Auto-offThe amount of time your workspace can be idle before Coder stops the workspace. Available only if your site manager has allowed this setting to be changed at the user level (otherwise the organization default applies).

By default, Coder allocates resources (CPU cores, memory, and disk space) based on the parent image. You can modify these starting values, though the maximum number of CPU cores, amount of memory, and allocation of disk space you can request for your workspace are determined by the Coder site manager on an organization level.

Coder displays a warning if you choose your resource settings and they're less than the image-recommended default, but you can still create the workspace.

When you're done making changes, click Create workspace to proceed. Coder redirects you to an overview page for your workspace during the build process.

.gitconfig files

If the image you're using to create your workspace doesn't include a .gitconfig file, Coder will generate one for you automatically using the details found in your Coder account.

You can modify the .gitconfig file, but we recommend using a personalization file to customize your workspace.

See an opportunity to improve our docs? Make an edit.