docker-documentation/images/docker-openvscode-server.md

title
openvscode-server

linuxserver/openvscode-server

Openvscode-server provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. 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/openvscode-server 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	Tag
x86-64	amd64-latest
arm64	arm64v8-latest
armhf	arm32v7-latest

Version Tags

This image provides various versions that are available via tags. latest tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.

Tag	Description
latest	Stable releases
insiders	Insiders releases

Application Setup

Access the webui at http://<your-ip>:3000?tkn=supersecrettoken. If CONNECTION_TOKEN or CONNECTION_SECRET env vars are set, replace supersecrettoken with the value set. If not, view the container logs (docker logs openvscode-server) to see the randomly generated token and replace supersecrettoken with that.

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"

When reverse proxied through SWAG, custom services running on specific ports inside openvscode-server can be accessed at https://PORT.openvscode-server.domain.com very much like how code-server's port proxy function is handled. For that, a wildcard CNAME *.openvscode-server.domain.com needs to be created and the SWAG cert needs to cover those subdomains.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

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

---
version: "2.1"
services:
  openvscode-server:
    image: lscr.io/linuxserver/openvscode-server
    container_name: openvscode-server
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
      - CONNECTION_TOKEN=supersecrettoken #optional
      - CONNECTION_SECRET= #optional
      - SUDO_PASSWORD=password #optional
      - SUDO_PASSWORD_HASH= #optional
    volumes:
      - /path/to/appdata/config:/config
    ports:
      - 3000:3000
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=openvscode-server \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -e CONNECTION_TOKEN=supersecrettoken `#optional` \
  -e CONNECTION_SECRET= `#optional` \
  -e SUDO_PASSWORD=password `#optional` \
  -e SUDO_PASSWORD_HASH= `#optional` \
  -p 3000:3000 \
  -v /path/to/appdata/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/openvscode-server

Parameters

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

Ports (-p)

Parameter	Function
3000	Web UI port.

Environment Variables (-e)

Env	Function
PUID=1000	for UserID - see below for explanation
PGID=1000	for GroupID - see below for explanation
TZ=Europe/London	Specify a timezone to use.
CONNECTION_TOKEN=supersecrettoken	Optional security token for accessing the Web UI.
CONNECTION_SECRET=	Optional path to a file inside the container that contains the security token for accessing the Web UI (ie. /path/to/file). Overrides CONNECTION_TOKEN.
SUDO_PASSWORD=password	If this optional variable is set, user will have sudo access in the openvscode-server terminal with the specified password.
SUDO_PASSWORD_HASH=	Optionally set sudo password via hash (takes priority over SUDO_PASSWORD var). Format is $type$salt$hashed.

Volume Mappings (-v)

Volume	Function
/config	Contains all relevant configuration files.

Miscellaneous Options

Parameter	Function

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__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword 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 user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

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:
  • docker exec -it openvscode-server /bin/bash
• To monitor the logs of the container in realtime:
  • docker logs -f openvscode-server
• Container version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' openvscode-server
• Image version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/openvscode-server

Versions

• 10.12.21: - Update deprecated connectionToken arg.
• 30.11.21: - Fix app folder permissions, add the optional sudo password vars.
• 29.11.21: - Create .profile and .bashrc for the user.
• 29.11.21: - Release insiders tag.
• 28.11.21: - Initial Release.