-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README.md - add and update badges
- Loading branch information
1 parent
f6a38e7
commit 55fd048
Showing
1 changed file
with
68 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,69 @@ | ||
| # alpine-code-server | ||
|
|
||
|    | ||
|
|
||
| [](https://hub.docker.com/r/martinussuherman/alpine) | ||
|
|
||
|   | ||
|
|
||
|   | ||
|
|
||
|   | ||
|
|
||
| --- | ||
|
|
||
| ## What is this image for ? | ||
|
|
||
| This is an [Minimal Alpine Linux image with glibc](https://hub.docker.com/r/jeanblanchard/alpine-glibc) based image for [code-server](https://github.com/cdr/code-server/). It enables one to run [VS Code](https://code.visualstudio.com/) in the browser. | ||
|
|
||
| --- | ||
|
|
||
| ## Why use this image? | ||
|
|
||
| *code-server* service on this container will run as `non-root` (`vscode`) user. This add an extra layer of security and are generally recommended for production environments. This container also allow mapping of the `user id` and `group id` of the user running docker to `vscode` user and group, which will enable the use of more restrictive file permission. | ||
|
|
||
| --- | ||
|
|
||
| ## How to use this image? | ||
|
|
||
| ### *Using docker run* | ||
|
|
||
| ```bash | ||
| $ docker run --name code-server -v ~/path/on/host:/home/vscode -e TZ=Asia/Jakarta -e EUID=$(id -u) -e EGID=$(id -g) -p 8080:8080 martinussuherman/alpine-code-server | ||
| ``` | ||
| # alpine-code-server | ||
|
|
||
|    | ||
|
|
||
| [](https://hub.docker.com/r/martinussuherman/alpine) | ||
|
|
||
|   | ||
|
|
||
|   | ||
|
|
||
|   | ||
|
|
||
|   | ||
|
|
||
|   | ||
|
|
||
|   | ||
|
|
||
|   | ||
|
|
||
|   | ||
|
|
||
|   | ||
|
|
||
| --- | ||
|
|
||
| ## What is this image for ? | ||
|
|
||
| This is an [Minimal Alpine Linux image with glibc](https://hub.docker.com/r/jeanblanchard/alpine-glibc) based image for [code-server](https://github.com/cdr/code-server/). It enables one to run [VS Code](https://code.visualstudio.com/) in the browser. | ||
|
|
||
| --- | ||
|
|
||
| ## Why use this image? | ||
|
|
||
| *code-server* service on this container will run as `non-root` (`vscode`) user. This add an extra layer of security and are generally recommended for production environments. This container also allow mapping of the `user id` and `group id` of the user running docker to `vscode` user and group, which will enable the use of more restrictive file permission. | ||
|
|
||
| --- | ||
|
|
||
| ## How to use this image? | ||
|
|
||
| ### *Using docker run* | ||
|
|
||
| ```bash | ||
| $ docker run --name code-server -v ~/path/on/host:/home/vscode -e TZ=Asia/Jakarta -e EUID=$(id -u) -e EGID=$(id -g) -p 8080:8080 martinussuherman/alpine-code-server | ||
| ``` | ||
| This will set the `timezone` to Asia/Jakarta (you will want to change it to your own timezone) and map the `user id` and `group id` of the current user to `vscode` user and group. | ||
|
|
||
| ### *Using docker-compose* | ||
|
|
||
| ```yaml | ||
| version: '3' | ||
|
|
||
| services: | ||
| code-server: | ||
| image: martinussuherman/alpine-code-server | ||
| environment: | ||
| - TZ=Asia/Jakarta | ||
| - EUID=1001 | ||
| - EGID=1001 | ||
| volumes: | ||
| - ~/path/on/host:/home/vscode | ||
| ports: | ||
| - 8080:8080 | ||
|
|
||
| ``` | ||
|
|
||
| *Note:* | ||
| 1. You will want to change the value for `EUID` and `EGID` with your current user `user id` and `group id`. | ||
| 2. *code-server* config file will be saved to `~/path/on/host/.config/code-server/config.yaml` | ||
|
|
||
| ### *Using docker-compose* | ||
|
|
||
| ```yaml | ||
| version: '3' | ||
|
|
||
| services: | ||
| code-server: | ||
| image: martinussuherman/alpine-code-server | ||
| environment: | ||
| - TZ=Asia/Jakarta | ||
| - EUID=1001 | ||
| - EGID=1001 | ||
| volumes: | ||
| - ~/path/on/host:/home/vscode | ||
| ports: | ||
| - 8080:8080 | ||
|
|
||
| ``` | ||
|
|
||
| *Note:* | ||
| 1. You will want to change the value for `EUID` and `EGID` with your current user `user id` and `group id`. | ||
| 2. *code-server* config file will be saved to `~/path/on/host/.config/code-server/config.yaml` |