Workspace parameters

3 min read

Learn about each parameter available during workspace creation.

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 Create Workspace (if available), or
  • Clicking New Workspace in the top-right

Create a workspace

When prompted, provide the following information:

Workspace name A friendly name for your workspace
Image source The 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.
Image The Docker image you want to use as the base for your workspace
Tag The version of the image you want to use
Workspace provider The Kubernetes cluster to which your workspace will be deployed. Default: built-in
Autostart Whether you want your workspace to turn on automatically at a specific time (you can set the autostart time in User Preferences.

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 machine Enable 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 URI The link to your Dotfiles repo; Coder will apply the settings prescribed every time your workspace rebuilds
CPU cores The number of CPU cores you'd like for your workspace
Memory The amount of memory you'd like for your workspace
Disk The amount of storage space you'd like for your workspace
GPU The number of GPUs you want allocated to your workspace

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 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.