Vscodium-web
Vscodium-web is a community-driven, freely-licensed binary distribution of the remote host web component of Microsoft's editor VS Code.
Image details
Configuration
TypeContainerlinuxlinuxserver/vscodium-web:latest8000:8000/tcp/config : /srv/lsio/vscodium-web/configPUID=1000PGID=1000TZ=Etc/UTCCONNECTION_TOKEN=CONNECTION_TOKEN_FILE=SUDO_PASSWORD=passwordSUDO_PASSWORD_HASH=CODE_ARGS=unless-stoppedTemplate by technorabilia
Notes
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/vscodium-web/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 Vscodium-web \
-p 8000:8000/tcp \
-e 'PUID=1000' \
-e 'PGID=1000' \
-e 'TZ=Etc/UTC' \
-e 'CONNECTION_TOKEN=' \
-e 'CONNECTION_TOKEN_FILE=' \
-e 'SUDO_PASSWORD=password' \
-e 'SUDO_PASSWORD_HASH=' \
-e 'CODE_ARGS=' \
-v /srv/lsio/vscodium-web/config:/config \
--restart=unless-stopped \
linuxserver/vscodium-web:latestSave this file as compose.yaml and run docker compose up -d
Use this only as a guide.
services:
vscodium-web:
image: linuxserver/vscodium-web:latest
ports:
- 8000:8000/tcp
volumes:
- /srv/lsio/vscodium-web/config:/config
environment:
PUID: '1000'
PGID: '1000'
TZ: Etc/UTC
CONNECTION_TOKEN: ''
CONNECTION_TOKEN_FILE: ''
SUDO_PASSWORD: password
SUDO_PASSWORD_HASH: ''
CODE_ARGS: ''
restart: unless-stopped
Save this file as vscodium-web-stack.yml, then from a manager node, run docker stack deploy -c vscodium-web-stack.yml vscodium-web
version: '3.8'
services:
vscodium-web:
image: linuxserver/vscodium-web:latest
ports:
- 8000:8000/tcp
volumes:
- /srv/lsio/vscodium-web/config:/config
environment:
PUID: '1000'
PGID: '1000'
TZ: Etc/UTC
CONNECTION_TOKEN: ''
CONNECTION_TOKEN_FILE: ''
SUDO_PASSWORD: password
SUDO_PASSWORD_HASH: ''
CODE_ARGS: ''
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.
vscodium-web-deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: vscodium-web
labels:
app: vscodium-web
spec:
replicas: 1
selector:
matchLabels:
app: vscodium-web
template:
metadata:
labels:
app: vscodium-web
spec:
containers:
- name: vscodium-web
image: linuxserver/vscodium-web:latest
env:
- name: PUID
value: '1000'
- name: PGID
value: '1000'
- name: TZ
value: Etc/UTC
- name: CONNECTION_TOKEN
value: ''
- name: CONNECTION_TOKEN_FILE
value: ''
- name: SUDO_PASSWORD
value: password
- name: SUDO_PASSWORD_HASH
value: ''
- name: CODE_ARGS
value: ''
ports:
- containerPort: 8000
protocol: TCP
volumeMounts:
- name: vscodium-web-data-0
mountPath: /config
volumes:
- name: vscodium-web-data-0
hostPath:
path: /srv/lsio/vscodium-web/config
vscodium-web-service.yaml
apiVersion: v1
kind: Service
metadata:
name: vscodium-web
spec:
type: LoadBalancer
selector:
app: vscodium-web
ports:
- name: 8000-tcp
port: 8000
targetPort: 8000
protocol: TCP
Save this file as ~/.config/containers/systemd/vscodium-web.container
[Unit]
Description=Vscodium-web
[Container]
Image=linuxserver/vscodium-web:latest
ContainerName=vscodium-web
PublishPort=8000:8000/tcp
Environment=PUID=1000
Environment=PGID=1000
Environment=TZ=Etc/UTC
Environment=CONNECTION_TOKEN=
Environment=CONNECTION_TOKEN_FILE=
Environment=SUDO_PASSWORD=password
Environment=SUDO_PASSWORD_HASH=
Environment=CODE_ARGS=
Volume=/srv/lsio/vscodium-web/config:/config
[Service]
Restart=always
[Install]
WantedBy=default.targetThen reload systemd and start the service:
systemctl --user daemon-reload
systemctl --user start vscodium-webFor 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/vscodium-web
Vscodium-web is a community-driven, freely-licensed binary distribution of the remote host web component of Microsoft's editor VS Code.
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/vscodium-web: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-\
Application Setup
>!NOTE >This image sets up theremote host web component of VSCodium, which is only accessible in a web browser. If you are looking for the full desktop client of VSCodium, served over Selkies, see here: https://github.com/linuxserver/docker-vscodiumIf
CONNECTION_TOKEN or CONNECTION_TOKEN_FILE env vars are set, you can access the webui at http://<your-ip>:8000/?tkn=supersecrettoken (replace supersecrettoken with the value set). If not, you can access the webui at http://<your-ip>:8000.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 commandsgit config --global user.name "username"
git config --global user.email "email address"When reverse proxied through SWAG, custom services running on specific ports inside vscodium-web can be accessed at
https://PORT.vscodium-web.domain.com very much like how code-server's port proxy function is handled. For that, a wildcard CNAME *.vscodium-web.domain.com needs to be created and the SWAG cert needs to cover those subdomains. Https access to a port can be initiated by adding an s to the end of the PORT in the url (ie. https://PORTs.vscodium-web.domain.com)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:
vscodium-web:
image: lscr.io/linuxserver/vscodium-web:latest
container_name: vscodium-web
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- CONNECTION_TOKEN= #optional
- CONNECTION_TOKEN_FILE= #optional
- SUDO_PASSWORD=password #optional
- SUDO_PASSWORD_HASH= #optional
- CODE_ARGS= #optional
volumes:
- /path/to/vscodium-web/config:/config
ports:
- 8000:8000
restart: unless-stoppeddocker cli (click here for more info)
docker run -d \
--name=vscodium-web \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e CONNECTION_TOKEN= `#optional` \
-e CONNECTION_TOKEN_FILE= `#optional` \
-e SUDO_PASSWORD=password `#optional` \
-e SUDO_PASSWORD_HASH= `#optional` \
-e CODE_ARGS= `#optional` \
-p 8000:8000 \
-v /path/to/vscodium-web/config:/config \
--restart unless-stopped \
lscr.io/linuxserver/vscodium-web:latestParameters
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 8000:8000 | Web UI port. |
| -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 CONNECTION_TOKEN= | Optional security token for accessing the Web UI (ie. supersecrettoken). |
| -e CONNECTION_TOKEN_FILE= | 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. |
| -e SUDO_PASSWORD=password | If this optional variable is set, user will have sudo access in the vscodium-web 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 CODE_ARGS= | Optionally add cli parameters to vscodium binary. |
| -v /config | Contains all relevant configuration files. |Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prependFILE__.As an example:
-e FILE__MYVAR=/run/secrets/mysecretvariableWill 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_userExample 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 vscodium-web /bin/bash
```- To monitor the logs of the container in realtime:
```bash
docker logs -f vscodium-web
```- Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' vscodium-web
```- Image version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/vscodium-web: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 vscodium-web
```- Update containers:
* All containers:
```bash
docker-compose up -d
```
* Single container:
```bash
docker-compose up -d vscodium-web
```- You can also remove the old dangling images:
```bash
docker image prune
```Via Docker Run
- Update the image:
```bash
docker pull lscr.io/linuxserver/vscodium-web:latest
```- Stop the running container:
```bash
docker stop vscodium-web
```- Delete the container:
```bash
docker rm vscodium-web
```- Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your
/configfolder 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-vscodium-web.git
cd docker-vscodium-web
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/vscodium-web:latest .The ARM variants can be built on x8664 hardware and vice versa using
lscr.io/linuxserver/qemu-staticdocker run --rm --privileged lscr.io/linuxserver/qemu-static --resetOnce registered you can define the dockerfile to use with
-f Dockerfile.aarch64.Versions
- 24.06.26: - Temporarily disable RISCV build due to ci issues.
- 28.02.26: - Add RISCV build.
- 18.12.25: - Initial Release.
Serve Vscodium-web 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.
Proxying vscodium-web.example.com to http://Vscodium-web:8000
Add this to your Caddyfile
vscodium-web.example.com {
reverse_proxy http://Vscodium-web:8000
}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 Vscodium-web - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Port already in use
If deployment fails with "Bind for 0.0.0.0:8000 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :8000 - Stop the other service, or pick a different host port. In
8000:8000only 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:8000. The 0.0.0.0 link Portainer shows isn't a real address. - Give it a minute after first deploy, Vscodium-web can take a while to initialise.
- Make sure your firewall allows the port, e.g.
sudo ufw allow 8000
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/vscodium-web/config - Or set the
PUIDandPGIDvariables (defaults 1000:1000) to match your own user, found withid $USER
Image won't pull
Test the pull directly on the host: docker pull linuxserver/vscodium-web: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 loginto 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, riscv64 - 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 Vscodium-web --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
Required settings are blank
CONNECTION_TOKEN, CONNECTION_TOKEN_FILE, SUDO_PASSWORD_HASH, CODE_ARGS have no default value, and Vscodium-web 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 Vscodium-web's repo
- Template not working: Open an issue on technorabilia/portainer-templates
- This website not working: Open an issue on lissy93/portainer-templates