2023-10-07 22:17:17 +02:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read https://github.com/linuxserver/docker - code - server/blob/master/.github/CONTRIBUTING.md -->
2019-06-24 20:03:06 +02:00
[](https://linuxserver.io)
2020-05-28 21:44:11 +02:00
[](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
[](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.")
[](https://discourse.linuxserver.io "post on our community forum.")
[](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.")
[](https://github.com/linuxserver "view the source for all of our repositories.")
[](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget")
2019-09-01 11:15:54 +02:00
2020-04-10 02:17:12 +02:00
The [LinuxServer.io ](https://linuxserver.io ) team brings you another container release featuring:
2019-06-24 20:03:06 +02:00
2021-04-18 14:28:31 +02:00
* 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
2019-06-24 20:03:06 +02:00
Find us at:
2021-04-18 14:28:31 +02:00
2019-06-24 20:03:06 +02:00
* [Blog ](https://blog.linuxserver.io ) - all the things you can do with our containers including How-To guides, opinions and much more!
2019-09-01 11:15:54 +02:00
* [Discord ](https://discord.gg/YWrKVTn ) - realtime support / chat with the community and the team.
* [Discourse ](https://discourse.linuxserver.io ) - post on our community forum.
* [Fleet ](https://fleet.linuxserver.io ) - an online web interface which displays all of our maintained images.
2019-10-30 19:17:21 +01:00
* [GitHub ](https://github.com/linuxserver ) - view the source for all of our repositories.
2019-09-01 11:15:54 +02:00
* [Open Collective ](https://opencollective.com/linuxserver ) - please consider helping us by either donating or contributing to our budget
2019-06-24 20:03:06 +02:00
# [linuxserver/code-server](https://github.com/linuxserver/docker-code-server)
2019-10-30 19:17:21 +01:00
2024-05-25 22:17:43 +02:00
[](https://scarf.sh)
2020-05-28 21:44:11 +02:00
[](https://github.com/linuxserver/docker-code-server)
[](https://github.com/linuxserver/docker-code-server/releases)
[](https://github.com/linuxserver/docker-code-server/packages)
2020-12-18 22:51:27 +01:00
[](https://gitlab.com/linuxserver.io/docker-code-server/container_registry)
2021-10-03 14:24:15 +02:00
[](https://quay.io/repository/linuxserver.io/code-server)
2020-05-28 21:44:11 +02:00
[](https://hub.docker.com/r/linuxserver/code-server)
[](https://hub.docker.com/r/linuxserver/code-server)
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-code-server/job/master/)
2020-11-02 16:17:04 +01:00
[](https://ci-tests.linuxserver.io/linuxserver/code-server/latest/index.html)
2019-06-24 20:03:06 +02:00
[Code-server ](https://coder.com ) 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.
2020-06-13 23:53:35 +02:00
[](https://coder.com)
2019-06-24 20:03:06 +02:00
## Supported Architectures
2023-11-18 15:39:32 +01:00
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here ](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list ) and our announcement [here ](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/ ).
2019-06-24 20:03:06 +02:00
2022-05-01 14:31:19 +02:00
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.
2019-06-24 20:03:06 +02:00
The architectures supported by this image are:
2022-05-01 14:31:19 +02:00
| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\<version tag\> |
| arm64 | ✅ | arm64v8-\<version tag\> |
2023-07-01 22:20:04 +02:00
| armhf | ❌ | |
2019-06-24 20:03:06 +02:00
2021-04-18 14:28:31 +02:00
## 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
```bash
git config --global user.name "username"
git config --global user.email "email address"
```
### Hashed code-server password
How to create the [hashed password ](https://github.com/cdr/code-server/blob/master/docs/FAQ.md#can-i-store-my-password-hashed ).
2019-06-24 20:03:06 +02:00
## Usage
2023-10-07 22:17:17 +02:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2019-06-24 20:03:06 +02:00
2024-12-04 20:37:02 +01:00
>[!NOTE]
>Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.
2021-07-04 14:24:37 +02:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2019-06-24 20:03:06 +02:00
2020-10-05 22:00:34 +02:00
```yaml
2019-06-24 20:03:06 +02:00
---
services:
code-server:
2022-05-01 14:31:19 +02:00
image: lscr.io/linuxserver/code-server:latest
2019-06-24 20:03:06 +02:00
container_name: code-server
environment:
- PUID=1000
- PGID=1000
2023-02-12 13:29:34 +01:00
- TZ=Etc/UTC
2019-06-24 21:27:16 +02:00
- PASSWORD=password #optional
2021-02-04 15:27:39 +01:00
- HASHED_PASSWORD= #optional
2019-07-09 23:29:50 +02:00
- SUDO_PASSWORD=password #optional
2020-12-24 02:03:43 +01:00
- SUDO_PASSWORD_HASH= #optional
2020-05-29 19:51:28 +02:00
- PROXY_DOMAIN=code-server.my.domain #optional
2021-12-06 16:21:29 +01:00
- DEFAULT_WORKSPACE=/config/workspace #optional
2019-06-24 20:03:06 +02:00
volumes:
2024-08-19 19:51:04 +02:00
- /path/to/code-server/config:/config
2019-06-24 20:03:06 +02:00
ports:
- 8443:8443
restart: unless-stopped
```
2021-07-04 14:24:37 +02:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2020-10-05 22:00:34 +02:00
2021-04-18 14:28:31 +02:00
```bash
2020-10-05 22:00:34 +02:00
docker run -d \
--name=code-server \
-e PUID=1000 \
-e PGID=1000 \
2023-02-12 13:29:34 +01:00
-e TZ=Etc/UTC \
2020-10-05 22:00:34 +02:00
-e PASSWORD=password `#optional` \
2021-02-04 15:27:39 +01:00
-e HASHED_PASSWORD= `#optional` \
2020-10-05 22:00:34 +02:00
-e SUDO_PASSWORD=password `#optional` \
2020-12-24 02:03:43 +01:00
-e SUDO_PASSWORD_HASH= `#optional` \
2020-10-05 22:00:34 +02:00
-e PROXY_DOMAIN=code-server.my.domain `#optional` \
2021-12-06 16:21:29 +01:00
-e DEFAULT_WORKSPACE=/config/workspace `#optional` \
2020-10-05 22:00:34 +02:00
-p 8443:8443 \
2024-08-19 19:51:04 +02:00
-v /path/to/code-server/config:/config \
2020-10-05 22:00:34 +02:00
--restart unless-stopped \
2022-05-01 14:31:19 +02:00
lscr.io/linuxserver/code-server:latest
2020-10-05 22:00:34 +02:00
```
2019-06-24 20:03:06 +02:00
## Parameters
2023-10-07 22:17:17 +02:00
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.
2019-06-24 20:03:06 +02:00
| Parameter | Function |
| :----: | --- |
2024-12-04 20:37:02 +01:00
| `-p 8443:8443` | web gui |
2019-06-24 20:03:06 +02:00
| `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation |
2023-02-12 13:29:34 +01:00
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list ](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List ). |
2021-02-04 15:27:39 +01:00
| `-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. |
2019-07-09 23:29:50 +02:00
| `-e SUDO_PASSWORD=password` | If this optional variable is set, user will have sudo access in the code-server terminal with the specified password. |
2020-12-24 02:03:43 +01:00
| `-e SUDO_PASSWORD_HASH=` | Optionally set sudo password via hash (takes priority over `SUDO_PASSWORD` var). Format is `$type$salt$hashed` . |
2024-10-13 19:32:44 +02:00
| `-e PROXY_DOMAIN=code-server.my.domain` | If this optional variable is set, this domain will be proxied for subdomain proxying. See [Documentation ](https://github.com/coder/code-server/blob/main/docs/guide.md#using-a-subdomain ) |
2021-12-06 16:21:29 +01:00
| `-e DEFAULT_WORKSPACE=/config/workspace` | If this optional variable is set, code-server will open this directory by default |
2019-06-24 20:03:06 +02:00
| `-v /config` | Contains all relevant configuration files. |
2019-12-01 11:15:47 +01:00
## Environment variables from files (Docker secrets)
2020-05-28 21:44:11 +02:00
You can set any environment variable from a file by using a special prepend `FILE__` .
2019-12-01 11:15:47 +01:00
As an example:
2021-04-18 14:28:31 +02:00
```bash
2023-10-07 22:17:17 +02:00
-e FILE__MYVAR=/run/secrets/mysecretvariable
2019-12-01 11:15:47 +01:00
```
2023-10-07 22:17:17 +02:00
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
2019-12-01 11:15:47 +01:00
2020-05-28 21:44:11 +02:00
## 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 ](https://en.wikipedia.org/wiki/Umask ) before asking for support.
2019-06-24 20:03:06 +02:00
## User / Group Identifiers
2023-10-07 22:17:17 +02:00
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` .
2019-06-24 20:03:06 +02:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2023-10-07 22:17:17 +02:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id your_user` as below:
2019-06-24 20:03:06 +02:00
2021-04-18 14:28:31 +02:00
```bash
2023-10-07 22:17:17 +02:00
id your_user
```
Example output:
```text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
2019-06-24 20:03:06 +02:00
```
2020-04-10 02:17:12 +02:00
## Docker Mods
2021-04-18 14:28:31 +02:00
2020-10-05 22:00:34 +02:00
[](https://mods.linuxserver.io/?mod=code-server "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-10 02:17:12 +02:00
2020-10-05 22:00:34 +02:00
We publish various [Docker Mods ](https://github.com/linuxserver/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.
2020-04-10 02:17:12 +02:00
2019-06-24 20:03:06 +02:00
## Support Info
2023-10-07 22:17:17 +02:00
* 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
```
2019-06-24 20:03:06 +02:00
## Updating Info
2024-01-13 21:19:04 +01:00
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 ](#application-setup ) section above to see if it is recommended for the image.
2019-09-01 11:15:54 +02:00
Below are the instructions for updating containers:
2019-06-24 20:03:06 +02:00
### Via Docker Compose
2021-04-18 14:28:31 +02:00
2023-10-07 22:17:17 +02:00
* 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
```
2019-06-24 20:03:06 +02:00
2020-10-05 22:00:34 +02:00
### Via Docker Run
2021-04-18 14:28:31 +02:00
2023-10-07 22:17:17 +02:00
* 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
```
2020-10-05 22:00:34 +02:00
* 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)
2023-10-07 22:17:17 +02:00
* You can also remove the old dangling images:
```bash
docker image prune
```
2020-10-05 22:00:34 +02:00
### Image Update Notifications - Diun (Docker Image Update Notifier)
2021-04-18 14:28:31 +02:00
2024-09-28 22:22:03 +02:00
>[!TIP]
>We recommend [Diun ](https://crazymax.dev/diun/ ) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
2019-06-24 20:03:06 +02:00
## Building locally
2019-09-01 11:15:54 +02:00
If you want to make local modifications to these images for development purposes or just to customize the logic:
2021-04-18 14:28:31 +02:00
```bash
2019-06-24 20:03:06 +02:00
git clone https://github.com/linuxserver/docker-code-server.git
cd docker-code-server
docker build \
--no-cache \
--pull \
2021-10-03 14:24:15 +02:00
-t lscr.io/linuxserver/code-server:latest .
2019-06-24 20:03:06 +02:00
```
2024-11-09 21:19:55 +01:00
The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`
2021-04-18 14:28:31 +02:00
```bash
2024-11-09 21:19:55 +01:00
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
2019-06-24 20:03:06 +02:00
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64` .
## Versions
2024-10-13 19:32:44 +02:00
* **13.10.24:** - Only chown config folder when change to ownership or new install is detected.
2024-10-10 18:22:07 +02:00
* **09.10.24:** - Manage permissions in /config/.ssh according to file type
2024-08-19 19:51:04 +02:00
* **19.08.24:** - Rebase to Ubuntu Noble.
2023-07-01 22:20:04 +02:00
* **01.07.23:** - Deprecate armhf. As announced [here ](https://www.linuxserver.io/blog/a-farewell-to-arm-hf )
2022-10-05 18:21:53 +02:00
* **05.10.22:** - Install recommended deps to maintain parity with the older images.
2022-09-29 15:40:19 +02:00
* **29.09.22:** - Rebase to jammy, switch to s6v3. Fix chown logic to skip `/config/workspace` contents.
2022-02-21 03:04:50 +01:00
* **20.02.22:** - Install using the official tarballs.
2021-12-29 21:01:59 +01:00
* **29.12.21:** - Add `install-extension` as a helper for mods to install extensions.
2021-12-06 16:21:29 +01:00
* **06.12.21:** - Add `DEFAULT_WORKSPACE` env var.
2021-11-29 19:00:15 +01:00
* **29.11.21:** - Rebase to Ubuntu focal.
2021-09-16 19:08:53 +02:00
* **16.09.21:** - Fix slow `chown` on large workspace (contents of workspace folder no longer chowned).
2021-07-11 21:15:47 +02:00
* **11.07.21:** - Bump node to 14 to fix builds
2021-05-08 16:50:21 +02:00
* **08.05.21:** - Fix doc link
2021-02-04 15:27:39 +01:00
* **04.02.20:** - Allow setting gui password via hash using env var `HASHED_PASSWORD` .
2020-12-24 02:03:43 +01:00
* **23.12.20:** - Allow setting sudo password via hash using env var `SUDO_PASSWORD_HASH` .
2020-05-29 19:51:28 +02:00
* **29.05.20:** - Add --domain-proxy support.
2020-05-21 21:30:45 +02:00
* **21.05.20:** - Shrink images, install via yarn, fix arm32v7 build.
2020-05-18 02:40:11 +02:00
* **18.05.20:** - Switch to multi-arch images, install via npm.
2020-04-30 00:45:31 +02:00
* **29.04.20:** - Update start arguments.
2020-04-02 03:49:46 +02:00
* **01.04.20:** - Structural changes required for v3.
2020-01-18 04:38:58 +01:00
* **17.01.20:** - Fix artifact url retrieval from github.
2019-10-24 21:51:46 +02:00
* **24.10.19:** - Upgrade to v2 builds.
2019-09-28 20:57:30 +02:00
* **28.09.19:** - Update project logo.
2019-09-21 07:23:10 +02:00
* **21.09.19:** - Add development builds/tag.
2019-07-09 23:29:50 +02:00
* **09.07.19:** - Add optional sudo access.
2019-07-01 21:48:53 +02:00
* **01.07.19:** - Add nano.
2019-06-24 20:03:06 +02:00
* **24.06.19:** - Initial Release.
