ls-code-server/readme-vars.yml

---

# project information
project_name: code-server
project_url: "https://coder.com"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/code-server-banner.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) is VS Code running on a remote server, accessible through the browser.

- Code on your Chromebook, tablet, and laptop with a consistent dev environment.

- If you have a Windows or Mac workstation, more easily develop for Linux.

- Take advantage of large cloud servers to speed up tests, compilations, downloads, and more.

- Preserve battery life when you're on the go.

- All intensive computation runs on your server.

- You're no longer running excess instances of Chrome."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"

# supported architectures
available_architectures:
  - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
  - { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}

# development version
development_versions: true
development_versions_items:
  - { tag: "latest", desc: "Stable releases" }
  - { tag: "development", desc: "DEPRECATED (no longer updated) - Prereleases from their GitHub" }

# container parameters
common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - { vol_path: "/config", vol_host_path: "/path/to/appdata/config", desc: "Contains all relevant configuration files." }
param_usage_include_ports: true
param_ports:
  - { external_port: "8443", internal_port: "8443", port_desc: "web gui" }
param_usage_include_env: true
param_env_vars:
  - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London" }

# optional container parameters
opt_param_usage_include_env: true
opt_param_env_vars:
  - { env_var: "PASSWORD", env_value: "password", desc: "Optional web gui password, if `PASSWORD` or `HASHED_PASSWORD` is not provided, there will be no auth." }
  - { env_var: "HASHED_PASSWORD", env_value: "", desc: "Optional web gui password, overrides `PASSWORD`, instructions on how to create it is below." }
  - { env_var: "SUDO_PASSWORD", env_value: "password", desc: "If this optional variable is set, user will have sudo access in the code-server terminal with the specified password." }
  - { env_var: "SUDO_PASSWORD_HASH", env_value: "", desc: "Optionally set sudo password via hash (takes priority over `SUDO_PASSWORD` var). Format is `$type$salt$hashed`." }
  - { env_var: "PROXY_DOMAIN", env_value: "code-server.my.domain", desc: "If this optional variable is set, this domain will be proxied for subdomain proxying. See [Documentation](https://github.com/cdr/code-server/blob/master/doc/FAQ.md#sub-domains)" }

optional_block_1: false
optional_block_1_items: ""

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  Access the webui at `http://<your-ip>:8443`.
  For github integration, drop your ssh key in to `/config/.ssh`.
  Then open a terminal from the top menu and set your github username and email via the following commands

  ```bash
  git config --global user.name "username"
  git config --global user.email "email address"
  ```

  ### Hashed code-server password
  To create the [hashed password](https://github.com/cdr/code-server/blob/master/doc/FAQ.md#can-i-store-my-password-hashed), use printf instead of echo as echo introduces newlines in the hash.


# changelog
changelogs:
  - { date: "04.02.20:", desc: "Allow setting gui password via hash using env var `HASHED_PASSWORD`." }
  - { date: "23.12.20:", desc: "Allow setting sudo password via hash using env var `SUDO_PASSWORD_HASH`." }
  - { date: "29.05.20:", desc: "Add --domain-proxy support." }
  - { date: "21.05.20:", desc: "Shrink images, install via yarn, fix arm32v7 build." }
  - { date: "18.05.20:", desc: "Switch to multi-arch images, install via npm." }
  - { date: "29.04.20:", desc: "Update start arguments." }
  - { date: "01.04.20:", desc: "Structural changes required for v3." }
  - { date: "17.01.20:", desc: "Fix artifact url retrieval from github." }
  - { date: "24.10.19:", desc: "Upgrade to v2 builds." }
  - { date: "28.09.19:", desc: "Update project logo." }
  - { date: "21.09.19:", desc: "Add development builds/tag." }
  - { date: "09.07.19:", desc: "Add optional sudo access." }
  - { date: "01.07.19:", desc: "Add nano." }
  - { date: "24.06.19:", desc: "Initial Release." }