code-server¶

Description / name	Input element
Your domain name

Overview¶

code-server is an open-source platform that enables developers to run Microsoft Visual Studio Code (VS Code) on a remote server and access it through a web browser, transforming VS Code into a cloud-based integrated development environment (IDE).

Manual

Releases

Community

Deployment¶

sb install sandbox-code-server

Usage¶

Visit https://code-server.iYOUR_DOMAIN_NAMEi.

Migration from the old `coder` role¶

The old coder role was renamed to code-server on Dec 19th 2022. In order to migrate to the new role, if you aren't using a custom folder for coder, rename the inventory variables if you have any, then run:

sb install sandbox-code-server -e 'code_server_migrate_coder=true'

The coder role is currently deprecated and won't receive any updates, so please run the migration to the new role as soon as possible.

Basics¶

Guide (possibly outdated)

Initial setup¶

By default, code-server will be available at https://code-server.iYOUR_DOMAIN_NAMEi.

The password is the one you set in accounts.yml

VSCode will present with a checklist of "getting started" items.

If you've never used VSCode before, take a few minutes to go through the fundamentals tutorial.

You can change the default theme if you wish. I'm going to choose the dark theme.

point it at the host `/opt` dir¶

Probably, you want to edit config files for the apps, which are in /opt.

The host /opt dir is mounted into the container as /host_opt/.

Choose File -> Open Folder... from the hamburger menu on the upper left:

Navigate to /host_opt/, click the arrow:

and you should be presented with your /opt directory. Most of the things you will want to edit are here.

This should stick the next time you load the app.

install some extensions¶

I suggest you install a few extensions:

Click on the Extensions icon on the left, then type the name of the extension into the search box, and click the "install" button.

Python:

Rainbow-indent:

Redhat YAML:

Better TOML:

Those are just suggestions; install others if you prefer.

Now, with these extensions installed, you should have syntax highlighting and indentation coloring for:

TOML

YAML

JSON

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
code_server_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like code_server_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

Instead, use the corresponding _custom variable (like code_server_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsWebDNSTraefikDockerDocker+Global Override Options

code_server_name

# Type: string
code_server_name: code-server

code_server_role_web_subdomain

# Type: string
code_server_role_web_subdomain: "{{ code_server_name }}"

code_server_role_web_domain

# Type: string
code_server_role_web_domain: "{{ user.domain }}"

code_server_role_web_port

# Type: string
code_server_role_web_port: "8080"

code_server_role_web_url

# Type: string
code_server_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='code_server') + '.' + lookup('role_var', '_web_domain', role='code_server')
                           if (lookup('role_var', '_web_subdomain', role='code_server') | length > 0)
                           else lookup('role_var', '_web_domain', role='code_server')) }}"

code_server_role_dns_record

# Type: string
code_server_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='code_server') }}"

code_server_role_dns_zone

# Type: string
code_server_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='code_server') }}"

code_server_role_dns_proxy

# Type: bool (true/false)
code_server_role_dns_proxy: "{{ dns_proxied }}"

code_server_role_traefik_sso_middleware

# Type: string
code_server_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

code_server_role_traefik_middleware_default

# Type: string
code_server_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

code_server_role_traefik_middleware_custom

# Type: string
code_server_role_traefik_middleware_custom: ""

code_server_role_traefik_certresolver

# Type: string
code_server_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

code_server_role_traefik_enabled

# Type: bool (true/false)
code_server_role_traefik_enabled: true

Container

code_server_role_docker_container

# Type: string
code_server_role_docker_container: "{{ code_server_name }}"

Image

code_server_role_docker_image_pull

# Type: bool (true/false)
code_server_role_docker_image_pull: true

code_server_role_docker_image_repo

# Type: string
code_server_role_docker_image_repo: "codercom/code-server"

code_server_role_docker_image_tag

# Type: string
code_server_role_docker_image_tag: "latest"

code_server_role_docker_image

# Type: string
code_server_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='code_server') }}:{{ lookup('role_var', '_docker_image_tag', role='code_server') }}"

Envs

code_server_role_docker_envs_default

# Type: dict
code_server_role_docker_envs_default:
  UMASK: "002"
  TZ: "{{ tz }}"
  PASSWORD: "{{ user.pass }}"
  DOCKER_USER: "{{ user.name }}"

code_server_role_docker_envs_custom

# Type: dict
code_server_role_docker_envs_custom: {}

Volumes

code_server_role_docker_volumes_default

# Type: list
code_server_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='code_server') }}/project:/home/coder/project"
  - "{{ lookup('role_var', '_paths_location', role='code_server') }}/.config:/home/coder/.config"
  - "{{ lookup('role_var', '_paths_location', role='code_server') }}/.local:/home/coder/.local"
  - "{{ server_appdata_path }}:/host_opt"

code_server_role_docker_volumes_custom

# Type: list
code_server_role_docker_volumes_custom: []

Hostname

code_server_role_docker_hostname

# Type: string
code_server_role_docker_hostname: "{{ code_server_name }}"

Networks

code_server_role_docker_networks_alias

# Type: string
code_server_role_docker_networks_alias: "{{ code_server_name }}"

code_server_role_docker_networks_default

# Type: list
code_server_role_docker_networks_default: []

code_server_role_docker_networks_custom

# Type: list
code_server_role_docker_networks_custom: []

Restart Policy

code_server_role_docker_restart_policy

# Type: string
code_server_role_docker_restart_policy: unless-stopped

State

code_server_role_docker_state

# Type: string
code_server_role_docker_state: started

User

code_server_role_docker_user

# Type: string
code_server_role_docker_user: "{{ uid }}:{{ gid }}"

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

code_server_role_docker_blkio_weight

# Type: int
code_server_role_docker_blkio_weight:

code_server_role_docker_cpu_period

# Type: int
code_server_role_docker_cpu_period:

code_server_role_docker_cpu_quota

# Type: int
code_server_role_docker_cpu_quota:

code_server_role_docker_cpu_shares

# Type: int
code_server_role_docker_cpu_shares:

code_server_role_docker_cpus

# Type: string
code_server_role_docker_cpus:

code_server_role_docker_cpuset_cpus

# Type: string
code_server_role_docker_cpuset_cpus:

code_server_role_docker_cpuset_mems

# Type: string
code_server_role_docker_cpuset_mems:

code_server_role_docker_kernel_memory

# Type: string
code_server_role_docker_kernel_memory:

code_server_role_docker_memory

# Type: string
code_server_role_docker_memory:

code_server_role_docker_memory_reservation

# Type: string
code_server_role_docker_memory_reservation:

code_server_role_docker_memory_swap

# Type: string
code_server_role_docker_memory_swap:

code_server_role_docker_memory_swappiness

# Type: int
code_server_role_docker_memory_swappiness:

code_server_role_docker_shm_size

# Type: string
code_server_role_docker_shm_size:

Security & Devices

code_server_role_docker_cap_drop

# Type: list
code_server_role_docker_cap_drop:

code_server_role_docker_cgroupns_mode

# Type: string
code_server_role_docker_cgroupns_mode:

code_server_role_docker_device_cgroup_rules

# Type: list
code_server_role_docker_device_cgroup_rules:

code_server_role_docker_device_read_bps

# Type: list
code_server_role_docker_device_read_bps:

code_server_role_docker_device_read_iops

# Type: list
code_server_role_docker_device_read_iops:

code_server_role_docker_device_requests

# Type: list
code_server_role_docker_device_requests:

code_server_role_docker_device_write_bps

# Type: list
code_server_role_docker_device_write_bps:

code_server_role_docker_device_write_iops

# Type: list
code_server_role_docker_device_write_iops:

code_server_role_docker_devices

# Type: list
code_server_role_docker_devices:

code_server_role_docker_devices_default

# Type: string
code_server_role_docker_devices_default:

code_server_role_docker_groups

# Type: list
code_server_role_docker_groups:

code_server_role_docker_privileged

# Type: bool (true/false)
code_server_role_docker_privileged:

code_server_role_docker_security_opts

# Type: list
code_server_role_docker_security_opts:

code_server_role_docker_userns_mode

# Type: string
code_server_role_docker_userns_mode:

Networking

code_server_role_docker_dns_opts

# Type: list
code_server_role_docker_dns_opts:

code_server_role_docker_dns_search_domains

# Type: list
code_server_role_docker_dns_search_domains:

code_server_role_docker_dns_servers

# Type: list
code_server_role_docker_dns_servers:

code_server_role_docker_domainname

# Type: string
code_server_role_docker_domainname:

code_server_role_docker_exposed_ports

# Type: list
code_server_role_docker_exposed_ports:

code_server_role_docker_hosts

# Type: dict
code_server_role_docker_hosts:

code_server_role_docker_hosts_use_common

# Type: bool (true/false)
code_server_role_docker_hosts_use_common:

code_server_role_docker_ipc_mode

# Type: string
code_server_role_docker_ipc_mode:

code_server_role_docker_links

# Type: list
code_server_role_docker_links:

code_server_role_docker_network_mode

# Type: string
code_server_role_docker_network_mode:

code_server_role_docker_pid_mode

# Type: string
code_server_role_docker_pid_mode:

code_server_role_docker_ports

# Type: list
code_server_role_docker_ports:

code_server_role_docker_uts

# Type: string
code_server_role_docker_uts:

Storage

code_server_role_docker_keep_volumes

# Type: bool (true/false)
code_server_role_docker_keep_volumes:

code_server_role_docker_mounts

# Type: list
code_server_role_docker_mounts:

code_server_role_docker_storage_opts

# Type: dict
code_server_role_docker_storage_opts:

code_server_role_docker_tmpfs

# Type: list
code_server_role_docker_tmpfs:

code_server_role_docker_volume_driver

# Type: string
code_server_role_docker_volume_driver:

code_server_role_docker_volumes_from

# Type: list
code_server_role_docker_volumes_from:

code_server_role_docker_volumes_global

# Type: bool (true/false)
code_server_role_docker_volumes_global:

code_server_role_docker_working_dir

# Type: string
code_server_role_docker_working_dir:

Monitoring & Lifecycle

code_server_role_docker_auto_remove

# Type: bool (true/false)
code_server_role_docker_auto_remove:

code_server_role_docker_cleanup

# Type: bool (true/false)
code_server_role_docker_cleanup:

code_server_role_docker_force_kill

# Type: string
code_server_role_docker_force_kill:

code_server_role_docker_healthcheck

# Type: dict
code_server_role_docker_healthcheck:

code_server_role_docker_healthy_wait_timeout

# Type: int
code_server_role_docker_healthy_wait_timeout:

code_server_role_docker_init

# Type: bool (true/false)
code_server_role_docker_init:

code_server_role_docker_kill_signal

# Type: string
code_server_role_docker_kill_signal:

code_server_role_docker_log_driver

# Type: string
code_server_role_docker_log_driver:

code_server_role_docker_log_options

# Type: dict
code_server_role_docker_log_options:

code_server_role_docker_oom_killer

# Type: bool (true/false)
code_server_role_docker_oom_killer:

code_server_role_docker_oom_score_adj

# Type: int
code_server_role_docker_oom_score_adj:

code_server_role_docker_output_logs

# Type: bool (true/false)
code_server_role_docker_output_logs:

code_server_role_docker_paused

# Type: bool (true/false)
code_server_role_docker_paused:

code_server_role_docker_recreate

# Type: bool (true/false)
code_server_role_docker_recreate:

code_server_role_docker_restart_retries

# Type: int
code_server_role_docker_restart_retries:

code_server_role_docker_stop_timeout

# Type: int
code_server_role_docker_stop_timeout:

Other Options

code_server_role_docker_capabilities

# Type: list
code_server_role_docker_capabilities:

code_server_role_docker_cgroup_parent

# Type: string
code_server_role_docker_cgroup_parent:

code_server_role_docker_commands

# Type: list
code_server_role_docker_commands:

code_server_role_docker_create_timeout

# Type: int
code_server_role_docker_create_timeout:

code_server_role_docker_entrypoint

# Type: string
code_server_role_docker_entrypoint:

code_server_role_docker_env_file

# Type: string
code_server_role_docker_env_file:

code_server_role_docker_labels

# Type: dict
code_server_role_docker_labels:

code_server_role_docker_labels_use_common

# Type: bool (true/false)
code_server_role_docker_labels_use_common:

code_server_role_docker_read_only

# Type: bool (true/false)
code_server_role_docker_read_only:

code_server_role_docker_runtime

# Type: string
code_server_role_docker_runtime:

code_server_role_docker_sysctls

# Type: list
code_server_role_docker_sysctls:

code_server_role_docker_ulimits

# Type: list
code_server_role_docker_ulimits:

code_server_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
code_server_role_autoheal_enabled: true

code_server_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
code_server_role_depends_on: ""

code_server_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
code_server_role_depends_on_delay: "0"

code_server_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
code_server_role_depends_on_healthchecks:

code_server_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
code_server_role_diun_enabled: true

code_server_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
code_server_role_dns_enabled: true

code_server_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
code_server_role_docker_controller: true

code_server_role_docker_image_repo

# Type: string
code_server_role_docker_image_repo:

code_server_role_docker_image_tag

# Type: string
code_server_role_docker_image_tag:

code_server_role_docker_volumes_download

# Type: bool (true/false)
code_server_role_docker_volumes_download:

code_server_role_paths_location

# Type: string
code_server_role_paths_location:

code_server_role_themepark_addons

# Type: string
code_server_role_themepark_addons:

code_server_role_themepark_app

# Type: string
code_server_role_themepark_app:

code_server_role_themepark_theme

# Type: string
code_server_role_themepark_theme:

code_server_role_traefik_api_endpoint

# Type: dict/omit
code_server_role_traefik_api_endpoint:

code_server_role_traefik_api_middleware

# Type: string
code_server_role_traefik_api_middleware:

code_server_role_traefik_api_middleware_http

# Type: string
code_server_role_traefik_api_middleware_http:

code_server_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
code_server_role_traefik_autodetect_enabled: false

code_server_role_traefik_certresolver

# Type: string
code_server_role_traefik_certresolver:

code_server_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
code_server_role_traefik_crowdsec_enabled: false

code_server_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
code_server_role_traefik_error_pages_enabled: false

code_server_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
code_server_role_traefik_gzip_enabled: false

code_server_role_traefik_middleware_http

# Type: string
code_server_role_traefik_middleware_http:

code_server_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
code_server_role_traefik_middleware_http_api_insecure:

code_server_role_traefik_middleware_http_insecure

# Type: bool (true/false)
code_server_role_traefik_middleware_http_insecure:

code_server_role_traefik_priority

# Type: string
code_server_role_traefik_priority:

code_server_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
code_server_role_traefik_robot_enabled: true

code_server_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
code_server_role_traefik_tailscale_enabled: false

code_server_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
code_server_role_traefik_wildcard_enabled: true

code_server_role_web_domain

# Type: string
code_server_role_web_domain:

code_server_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
code_server_role_web_fqdn_override:

Example Override

code_server_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "code_server2.{{ user.domain }}"
  - "code_server.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

code_server_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
code_server_role_web_host_override: