Code-server

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

Image details

Pulls: 69.8M

Architectures: amd64, arm64

Image size: 268 MB

Latest: 4.129.0

User: linuxserver

Created: Jun 27, 2019

Updated: 3 days ago

Status: active

Configuration

Type

Container

Platform

linux

Image

linuxserver/code-server:latest

Ports

8443:8443/tcp

Volumes

/config : /srv/lsio/code-server/config

Env vars

PUID=1000PGID=1000TZ=Etc/UTCPASSWORD=passwordHASHED_PASSWORD=SUDO_PASSWORD=passwordSUDO_PASSWORD_HASH=PROXY_DOMAIN=code-server.my.domainDEFAULT_WORKSPACE=/config/workspacePWA_APPNAME=code-server

Restart

unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/code-server/config

Installation

Ensure both Docker and Portainer are installed, and up-to-date
Log into your Portainer web UI
Under Settings → App Templates, paste the below URL
Head to Home → App Templates, and the list of apps will show up
Select the app you wish to deploy, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json

Show Me

docker run -d --name Code-server \
  -p 8443:8443/tcp \
  -e 'PUID=1000' \
  -e 'PGID=1000' \
  -e 'TZ=Etc/UTC' \
  -e 'PASSWORD=password' \
  -e 'HASHED_PASSWORD=' \
  -e 'SUDO_PASSWORD=password' \
  -e 'SUDO_PASSWORD_HASH=' \
  -e 'PROXY_DOMAIN=code-server.my.domain' \
  -e 'DEFAULT_WORKSPACE=/config/workspace' \
  -e 'PWA_APPNAME=code-server' \
  -v /srv/lsio/code-server/config:/config \
  --restart=unless-stopped \
  linuxserver/code-server:latest

Save this file as compose.yaml and run docker compose up -d
Use this only as a guide.

services:
  code-server:
    image: linuxserver/code-server:latest
    ports:
      - 8443:8443/tcp
    volumes:
      - /srv/lsio/code-server/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
      PASSWORD: password
      HASHED_PASSWORD: ''
      SUDO_PASSWORD: password
      SUDO_PASSWORD_HASH: ''
      PROXY_DOMAIN: code-server.my.domain
      DEFAULT_WORKSPACE: /config/workspace
      PWA_APPNAME: code-server
    restart: unless-stopped

Save this file as code-server-stack.yml, then from a manager node, run docker stack deploy -c code-server-stack.yml code-server

version: '3.8'
services:
  code-server:
    image: linuxserver/code-server:latest
    ports:
      - 8443:8443/tcp
    volumes:
      - /srv/lsio/code-server/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
      PASSWORD: password
      HASHED_PASSWORD: ''
      SUDO_PASSWORD: password
      SUDO_PASSWORD_HASH: ''
      PROXY_DOMAIN: code-server.my.domain
      DEFAULT_WORKSPACE: /config/workspace
      PWA_APPNAME: code-server
    deploy:
      restart_policy:
        condition: any

Save each file below into a folder, then run kubectl apply -f .
Written for k3s, but works on any cluster: bind mounts use hostPath, named volumes get a persistent volume claim, and ports are exposed via a LoadBalancer service.

`code-server-deployment.yaml`

apiVersion: apps/v1
kind: Deployment
metadata:
  name: code-server
  labels:
    app: code-server
spec:
  replicas: 1
  selector:
    matchLabels:
      app: code-server
  template:
    metadata:
      labels:
        app: code-server
    spec:
      containers:
        - name: code-server
          image: linuxserver/code-server:latest
          env:
            - name: PUID
              value: '1000'
            - name: PGID
              value: '1000'
            - name: TZ
              value: Etc/UTC
            - name: PASSWORD
              value: password
            - name: HASHED_PASSWORD
              value: ''
            - name: SUDO_PASSWORD
              value: password
            - name: SUDO_PASSWORD_HASH
              value: ''
            - name: PROXY_DOMAIN
              value: code-server.my.domain
            - name: DEFAULT_WORKSPACE
              value: /config/workspace
            - name: PWA_APPNAME
              value: code-server
          ports:
            - containerPort: 8443
              protocol: TCP
          volumeMounts:
            - name: code-server-data-0
              mountPath: /config
      volumes:
        - name: code-server-data-0
          hostPath:
            path: /srv/lsio/code-server/config

`code-server-service.yaml`

apiVersion: v1
kind: Service
metadata:
  name: code-server
spec:
  type: LoadBalancer
  selector:
    app: code-server
  ports:
    - name: 8443-tcp
      port: 8443
      targetPort: 8443
      protocol: TCP

Save this file as ~/.config/containers/systemd/code-server.container

[Unit]
Description=Code-server

[Container]
Image=linuxserver/code-server:latest
ContainerName=code-server
PublishPort=8443:8443/tcp
Environment=PUID=1000
Environment=PGID=1000
Environment=TZ=Etc/UTC
Environment=PASSWORD=password
Environment=HASHED_PASSWORD=
Environment=SUDO_PASSWORD=password
Environment=SUDO_PASSWORD_HASH=
Environment=PROXY_DOMAIN=code-server.my.domain
Environment=DEFAULT_WORKSPACE=/config/workspace
Environment=PWA_APPNAME=code-server
Volume=/srv/lsio/code-server/config:/config

[Service]
Restart=always

[Install]
WantedBy=default.target

Then reload systemd and start the service:

systemctl --user daemon-reload
systemctl --user start code-server

For a system-wide service, use /etc/containers/systemd/ and drop --user.

For more installation options, see the Documentation in our GitHub repo

The LinuxServer.io team brings you another container release featuring:

regular and timely application updates
easy user mappings (PGID, PUID)
custom base image with s6 overlay
weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
regular security updates

Find us at:

Blog - all the things you can do with our containers including How-To guides, opinions and much more!
Discord - realtime support / chat with the community and the team.
Discourse - post on our community forum.
GitHub - view the source for all of our repositories.
Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/code-server

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

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/code-server:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
| Architecture | Available | Tag | | :----: | :----: | ---- | | x86-64 | ✅ | amd64-\ | | arm64 | ✅ | arm64v8-\ |

Application Setup

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

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

Hashed code-server password

How to create the hashed password.

Read-Only Operation

This image can be run with a read-only container filesystem. For details please read the docs.

Caveats

/tmp must be mounted to tmpfs
sudo will not be available

Non-Root Operation

This image can be run with a non-root user. For details please read the docs.

Caveats

sudo will not be available

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
>!NOTE >Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, click here for more info)

---
services:
  code-server:
    image: lscr.io/linuxserver/code-server:latest
    container_name: code-server
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - PASSWORD=password #optional
      - HASHED_PASSWORD= #optional
      - SUDO_PASSWORD=password #optional
      - SUDO_PASSWORD_HASH= #optional
      - PROXY_DOMAIN=code-server.my.domain #optional
      - DEFAULT_WORKSPACE=/config/workspace #optional
      - PWA_APPNAME=code-server #optional
    volumes:
      - /path/to/code-server/config:/config
    ports:
      - 8443:8443
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=code-server \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e PASSWORD=password `#optional` \
  -e HASHED_PASSWORD= `#optional` \
  -e SUDO_PASSWORD=password `#optional` \
  -e SUDO_PASSWORD_HASH= `#optional` \
  -e PROXY_DOMAIN=code-server.my.domain `#optional` \
  -e DEFAULT_WORKSPACE=/config/workspace `#optional` \
  -e PWA_APPNAME=code-server `#optional` \
  -p 8443:8443 \
  -v /path/to/code-server/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/code-server:latest

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.
| Parameter | Function | | :----: | --- | | -p 8443:8443 | web gui | | -e PUID=1000 | for UserID - see below for explanation | | -e PGID=1000 | for GroupID - see below for explanation | | -e TZ=Etc/UTC | specify a timezone to use, see this list. | | -e PASSWORD=password | Optional web gui password, if PASSWORD or HASHED_PASSWORD is not provided, there will be no auth. | | -e HASHED_PASSWORD= | Optional web gui password, overrides PASSWORD, instructions on how to create it is below. | | -e SUDO_PASSWORD=password | If this optional variable is set, user will have sudo access in the code-server terminal with the specified password. | | -e SUDO_PASSWORD_HASH= | Optionally set sudo password via hash (takes priority over SUDO_PASSWORD var). Format is $type$salt$hashed. | | -e PROXY_DOMAIN=code-server.my.domain | If this optional variable is set, this domain will be proxied for subdomain proxying. See Documentation | | -e DEFAULT_WORKSPACE=/config/workspace | If this optional variable is set, code-server will open this directory by default | | -e PWA_APPNAME=code-server | If this optional variable is set, the PWA app will the specified name. | | -v /config | Contains all relevant configuration files. | | --read-only=true | Run container with a read-only filesystem. Please read the docs. | | --user=1000:1000 | Run container with a non-root user. Please read the docs. |

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

Shell access whilst the container is running:

```bash
docker exec -it code-server /bin/bash
```

To monitor the logs of the container in realtime:

```bash
docker logs -f code-server
```

Container version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' code-server
```

Image version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/code-server:latest
```

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:

Via Docker Compose

Update images:

* All images:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull code-server
    ```

Update containers:

* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d code-server
    ```

You can also remove the old dangling images:

```bash
docker image prune
```

Via Docker Run

Update the image:

```bash
docker pull lscr.io/linuxserver/code-server:latest
```

Stop the running container:

```bash
docker stop code-server
```

Delete the container:

```bash
docker rm code-server
```

Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
You can also remove the old dangling images:

```bash
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

>!TIP >We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-code-server.git
cd docker-code-server
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/code-server:latest .

The ARM variants can be built on x8664 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions
17.05.26: - Let server listen on both ipv4 and ipv6 even when running container as root.
10.08.25: - Let server listen on both ipv4 and ipv6.
03.06.25: - Allow setting PWA name using env var PWA_APPNAME.
13.10.24: - Only chown config folder when change to ownership or new install is detected.
09.10.24: - Manage permissions in /config/.ssh according to file type
19.08.24: - Rebase to Ubuntu Noble.
01.07.23: - Deprecate armhf. As announced here
05.10.22: - Install recommended deps to maintain parity with the older images.
29.09.22: - Rebase to jammy, switch to s6v3. Fix chown logic to skip /config/workspace contents.
20.02.22: - Install using the official tarballs.
29.12.21: - Add install-extension as a helper for mods to install extensions.
06.12.21: - Add DEFAULT_WORKSPACE env var.
29.11.21: - Rebase to Ubuntu focal.
16.09.21: - Fix slow chown on large workspace (contents of workspace folder no longer chowned).
11.07.21: - Bump node to 14 to fix builds
08.05.21: - Fix doc link
04.02.20: - Allow setting gui password via hash using env var HASHED_PASSWORD.
23.12.20: - Allow setting sudo password via hash using env var SUDO_PASSWORD_HASH.
29.05.20: - Add --domain-proxy support.
21.05.20: - Shrink images, install via yarn, fix arm32v7 build.
18.05.20: - Switch to multi-arch images, install via npm.
29.04.20: - Update start arguments.
01.04.20: - Structural changes required for v3.
17.01.20: - Fix artifact url retrieval from github.
24.10.19: - Upgrade to v2 builds.
28.09.19: - Update project logo.
21.09.19: - Add development builds/tag.
09.07.19: - Add optional sudo access.
01.07.19: - Add nano.
24.06.19: - Initial Release.

Serve Code-server on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxy Domain App port Upstream

Proxying code-server.example.com to https://Code-server:8443

Add this to your Caddyfile

code-server.example.com {
	reverse_proxy https://Code-server:8443 {
		transport http {
			tls_insecure_skip_verify
		}
	}
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

In Portainer, go to Containers, click the container, then Logs. Or run docker logs Code-server
Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8443 failed: port is already allocated", something else on your server is using that port.

Find what's using it: sudo ss -tlnp | grep :8443
Stop the other service, or pick a different host port. In 8443:8443 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

Use your server's real IP: http://your-server-ip:8443. The 0.0.0.0 link Portainer shows isn't a real address.
Give it a minute after first deploy, Code-server can take a while to initialise.
Make sure your firewall allows the port, e.g. sudo ufw allow 8443

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/code-server/config
Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/code-server:latest

"manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
"toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
"no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

This image supports: amd64, arm64
Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

Check the logs right after a restart, the last few lines before it died are the useful ones.
Get the exit code with docker inspect Code-server --format '{{.State.ExitCode}}'
Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

HASHED_PASSWORD, SUDO_PASSWORD_HASH have no default value, and Code-server may crash or misbehave if left empty.

Fill them in on the deploy screen before hitting deploy.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

Bug within the app: Open an issue within Code-server's repo
Template not working: Open an issue on technorabilia/portainer-templates
This website not working: Open an issue on lissy93/portainer-templates

Similar apps

Github-desktop Programming

Gitqlient Programming

Intellij-idea Programming

Pycharm Programming

Vscode Programming

Vscodium Programming

Vscodium-web Programming

Yaak Programming

Code-server

Image details

Configuration

Notes

Installation

Via Portainer

Template Import URL

Docker Run

Docker Compose

Docker Swarm

Kubernetes

code-server-deployment.yaml

code-server-service.yaml

Podman Quadlet

Alternative Methods

Container Documentation

linuxserver/code-server

Supported Architectures

Application Setup

Hashed code-server password

Read-Only Operation

Caveats

Non-Root Operation

Caveats

Usage

docker-compose (recommended, click here for more info)

docker cli (click here for more info)

Parameters

Environment variables from files (Docker secrets)

Umask for running applications

User / Group Identifiers

Docker Mods

Support Info

Updating Info

Via Docker Compose

Via Docker Run

Image Update Notifications - Diun (Docker Image Update Notifier)

Building locally

Versions

Recent versions

Proxy configurator

Troubleshooting

Check the logs first

Port already in use

Running but the page won't load

Permission denied on volumes

Image won't pull

"exec format error"

Container keeps restarting

Required settings are blank

Raise an issue

Similar apps

`code-server-deployment.yaml`

`code-server-service.yaml`