ls-code-server/README.md

287 lines
17 KiB
Markdown
Raw Permalink Normal View History

2020-10-05 22:00:34 +02:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2021-04-18 14:28:31 +02:00
<!-- Please read the https://github.com/linuxserver/docker-code-server/blob/master/.github/CONTRIBUTING.md -->
2020-10-05 22:00:34 +02:00
2019-06-24 20:03:06 +02:00
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
2020-05-28 21:44:11 +02:00
[![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
[![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.")
[![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=discourse)](https://discourse.linuxserver.io "post on our community forum.")
[![Fleet](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Fleet)](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.")
[![GitHub](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub&logo=github)](https://github.com/linuxserver "view the source for all of our repositories.")
[![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Supporters&logo=open%20collective)](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
2020-05-28 21:44:11 +02:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-code-server.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-code-server)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-code-server.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-code-server/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-code-server/packages)
2020-12-18 22:51:27 +01:00
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-code-server/container_registry)
2021-10-03 14:24:15 +02:00
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/code-server)
2020-05-28 21:44:11 +02:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/code-server.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/code-server)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/code-server.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/code-server)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-code-server%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-code-server/job/master/)
2020-11-02 16:17:04 +01:00
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fcode-server%2Flatest%2Fci-status.yml)](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
[![code-server](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/code-server-banner.png)](https://coder.com)
2019-06-24 20:03:06 +02:00
## Supported Architectures
2019-09-01 11:15:54 +02:00
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](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#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
2021-10-03 14:24:15 +02:00
Simply pulling `lscr.io/linuxserver/code-server` 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:
| Architecture | Tag |
| :----: | --- |
| x86-64 | amd64-latest |
2020-05-18 02:40:11 +02:00
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
2019-06-24 20:03:06 +02:00
2019-09-21 07:23:10 +02:00
## 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 |
2021-11-29 19:00:15 +01:00
| focal | DEPRECATED (no longer updated, `latest` is rebased on focal) - Stable releases, based on Ubuntu Focal |
| development | DEPRECATED (no longer updated) - Prereleases from their GitHub |
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
Here are some example snippets to help you get started creating a container.
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
---
2020-04-10 02:17:12 +02:00
version: "2.1"
2019-06-24 20:03:06 +02:00
services:
code-server:
2021-10-03 14:24:15 +02:00
image: lscr.io/linuxserver/code-server
2019-06-24 20:03:06 +02:00
container_name: code-server
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
2019-06-24 21:27:16 +02:00
- PASSWORD=password #optional
2021-02-04 15:27:39 +01:00
- HASHED_PASSWORD= #optional
- 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:
- /path/to/appdata/config:/config
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 \
-e TZ=Europe/London \
-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 \
-v /path/to/appdata/config:/config \
--restart unless-stopped \
2021-10-03 14:24:15 +02:00
lscr.io/linuxserver/code-server
2020-10-05 22:00:34 +02:00
```
2019-06-24 20:03:06 +02:00
## Parameters
Container 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.
| Parameter | Function |
| :----: | --- |
| `-p 8443` | web gui |
| `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation |
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London |
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. |
| `-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`. |
2021-05-08 16:50:21 +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/cdr/code-server/blob/master/docs/FAQ.md#sub-domains) |
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
2019-12-01 11:15:47 +01:00
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
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
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:
2021-04-18 14:28:31 +02:00
```bash
2019-06-24 20:03:06 +02:00
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
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
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=code-server&query=%24.mods%5B%27code-server%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=code-server "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](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
* Shell access whilst the container is running: `docker exec -it code-server /bin/bash`
* To monitor the logs of the container in realtime: `docker logs -f code-server`
2019-09-01 11:15:54 +02:00
* container version number
2019-06-24 20:03:06 +02:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' code-server`
* image version number
2021-10-03 14:24:15 +02:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/code-server`
2019-06-24 20:03:06 +02:00
## Updating Info
2019-09-01 11:15:54 +02:00
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), 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.
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
2019-06-24 20:03:06 +02:00
* Update all images: `docker-compose pull`
* or update a single image: `docker-compose pull code-server`
* Let compose update all containers as necessary: `docker-compose up -d`
* or update a single container: `docker-compose up -d code-server`
* You can also remove the old dangling images: `docker image prune`
2020-10-05 22:00:34 +02:00
### Via Docker Run
2021-04-18 14:28:31 +02:00
2021-10-03 14:24:15 +02:00
* Update the image: `docker pull lscr.io/linuxserver/code-server`
2020-10-05 22:00:34 +02:00
* Stop the running container: `docker stop code-server`
* Delete the container: `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: `docker image prune`
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
2021-04-18 14:28:31 +02:00
2019-06-24 20:03:06 +02:00
* Pull the latest image at its tag and replace it with the same env variables in one run:
2021-04-18 14:28:31 +02:00
```bash
2019-06-24 20:03:06 +02:00
docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower \
--run-once code-server
```
2021-04-18 14:28:31 +02:00
2020-10-05 22:00:34 +02:00
* You can also remove the old dangling images: `docker image prune`
2019-07-07 11:16:02 +02:00
2020-10-05 22:00:34 +02:00
**Note:** We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
2019-07-07 11:16:02 +02:00
2020-10-05 22:00:34 +02:00
### Image Update Notifications - Diun (Docker Image Update Notifier)
2021-04-18 14:28:31 +02:00
2020-10-05 22:00:34 +02:00
* 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
```
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
2021-04-18 14:28:31 +02:00
```bash
2019-06-24 20:03:06 +02:00
docker run --rm --privileged multiarch/qemu-user-static:register --reset
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
## Versions
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.
* **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.
* **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.