diff --git a/images/docker-code-server.md b/images/docker-code-server.md index 08580be53..9af78811b 100644 --- a/images/docker-code-server.md +++ b/images/docker-code-server.md @@ -1,6 +1,9 @@ --- title: code-server --- + + + # [linuxserver/code-server](https://github.com/linuxserver/docker-code-server) [![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) @@ -44,6 +47,21 @@ This image provides various versions that are available via tags. `latest` tag u | latest | Stable releases | | development | DEPRECATED (no longer updated) - Prereleases from their GitHub | +## Application Setup + +Access the webui at `http://: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). + ## Usage Here are some example snippets to help you get started creating a container from this image. @@ -77,7 +95,7 @@ services: ### docker cli -``` +```bash docker run -d \ --name=code-server \ -e PUID=1000 \ @@ -94,7 +112,6 @@ docker run -d \ ghcr.io/linuxserver/code-server ``` - ## Parameters Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. @@ -105,7 +122,6 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `8443` | web gui | - ### Environment Variables (`-e`) | Env | Function | @@ -125,15 +141,13 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `/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 prepend `FILE__`. As an example: -``` +```bash -e FILE__PASSWORD=/run/secrets/mysecretpassword ``` @@ -144,7 +158,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/ 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. - ## 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`. @@ -153,33 +166,17 @@ Ensure any volume directories on the host are owned by the same user you specify In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -``` +```bash $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` -## Application Setup - -Access the webui at `http://: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). - - ## Docker Mods + [![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.") 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. - ## Support Info * Shell access whilst the container is running: