Code Server¶

Code Server is a web based VSCode UI that allows you to run your projects from within the server. We'll use it in this case to manage the docker compose stacks through this.

There is an official image for this service that we'll use: ghcr.io/linuxserver/code-server.

Pre-Installation¶

We'll create a folder in the main user's home where all the service's data will be saved.

mkdir ~/services/development/code-server

Docker Compose¶

Code Server will be run using Docker Compose. The content of the docker-compose.yml file is as follows:

services:
  web:
    image: ghcr.io/linuxserver/code-server:latest
    restart: unless-stopped
    extra_hosts:
      - host.docker.internal:host-gateway
    networks:
      default:
      proxy_external:
        aliases:
          - code-server
    volumes:
      - ./config:/config
      - ~/:/config/workspace
    environment:
      TZ: America/Guayaquil
      PUID: 1000
      PGID: 1000
      PASSWORD: UI_PASSWORD
    labels:
      traefik.enable: true
      traefik.docker.network: proxy_external
      traefik.http.routers.code-server.rule: Host(`code.home.example.com`) || Host(`code.vpn.example.com`)
      traefik.http.routers.code-server.entrypoints: local-https
      traefik.http.routers.code-server.tls: true
      traefik.http.routers.code-server.tls.certresolver: le
      traefik.http.routers.code-server.service: code-server@docker
      traefik.http.services.code-server.loadbalancer.server.port: 8443

networks:
  proxy_external:
    external: true

Reverse Proxy¶

This service is exposed by a reverse proxy. More specifically, it is using Traefik.

For this reason, you will see that this service has:

1. A directive to connect it to the proxy_external external network.
2. A container alias for the proxy_external network.
3. A number of labels with names starting with traefik.

If you're not using a reverse proxy, feel free to remove these from the docker-compose.yml file. Keep in mind you might need to bind the ports to connect to the service instead.

Running¶

Start up the service with:

docker compose up -d

That's it! The service will auto-start on system startup and restart on failure.