kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
3a2410e245
commit
a0c7bb2d4f
|
|
@ -1,15 +1,22 @@
|
|||
# linuxserver/code-server
|
||||
# [linuxserver/code-server](https://github.com/linuxserver/docker-code-server)
|
||||
|
||||
[](https://github.com/linuxserver/docker-code-server) [](https://github.com/linuxserver/docker-code-server/releases) [](https://github.com/linuxserver/docker-code-server/packages) [](https://gitlab.com/Linuxserver.io/docker-code-server/container_registry) [](https://microbadger.com/images/linuxserver/code-server) [](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/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/code-server/latest/index.html)
|
||||
[](https://github.com/linuxserver/docker-code-server)
|
||||
[](https://github.com/linuxserver/docker-code-server/releases)
|
||||
[](https://github.com/linuxserver/docker-code-server/packages)
|
||||
[](https://gitlab.com/Linuxserver.io/docker-code-server/container_registry)
|
||||
[](https://microbadger.com/images/linuxserver/code-server "Get your own version badge on microbadger.com")
|
||||
[](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/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/code-server/latest/index.html)
|
||||
|
||||
[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.
|
||||
- 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.
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
|
|
@ -20,7 +27,7 @@ Simply pulling `linuxserver/code-server` should retrieve the correct image for y
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v7-latest |
|
||||
|
|
@ -30,7 +37,7 @@ The architectures supported by this image are:
|
|||
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 |
|
||||
| development | Prereleases from their GitHub |
|
||||
|
||||
|
|
@ -40,7 +47,7 @@ Here are some example snippets to help you get started creating a container from
|
|||
|
||||
### docker
|
||||
|
||||
```text
|
||||
```
|
||||
docker create \
|
||||
--name=code-server \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -55,6 +62,7 @@ docker create \
|
|||
linuxserver/code-server
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -82,18 +90,19 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker 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.
|
||||
Docker 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.
|
||||
|
||||
### Ports \(`-p`\)
|
||||
### Ports (`-p`)
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `8443` | web gui |
|
||||
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
|
||||
|
|
@ -101,19 +110,21 @@ Docker images are configured using parameters passed at runtime \(such as those
|
|||
| `SUDO_PASSWORD=password` | If this optional variable is set, user will have sudo access in the code-server terminal with the specified password. |
|
||||
| `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/doc/FAQ.md#sub-domains) |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `/config` | Contains all relevant configuration files. |
|
||||
|
||||
## Environment variables from files \(Docker secrets\)
|
||||
|
||||
|
||||
## Environment variables from files (Docker secrets)
|
||||
|
||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||
|
||||
As an example:
|
||||
|
||||
```text
|
||||
```
|
||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||
```
|
||||
|
||||
|
|
@ -121,17 +132,19 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
|||
|
||||
## 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.
|
||||
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`.
|
||||
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:
|
||||
|
||||
```text
|
||||
```
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
|
@ -140,18 +153,18 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
|||
|
||||
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
|
||||
|
||||
```text
|
||||
Then open a terminal from the top menu and set your github username and email via the following commands
|
||||
```
|
||||
git config --global user.name "username"
|
||||
git config --global user.email "email address"
|
||||
```
|
||||
|
||||
|
||||
## Docker Mods
|
||||
[](https://mods.linuxserver.io/?mod=code-server "view available mods for this container.")
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=code-server)
|
||||
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) can be accessed via the dynamic badge above.
|
||||
|
||||
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\) can be accessed via the dynamic badge above.
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -178,4 +191,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
|||
* **09.07.19:** - Add optional sudo access.
|
||||
* **01.07.19:** - Add nano.
|
||||
* **24.06.19:** - Initial Release.
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue