Skip to content

Commit dc4c0ed

Browse files
Bot Updating Templated Files
1 parent 245c261 commit dc4c0ed

File tree

2 files changed

+41
-35
lines changed

2 files changed

+41
-35
lines changed

.github/CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ If you are proposing additional packages to be added, ensure that you added the
9696

9797
### Testing your changes
9898

99-
```
99+
```bash
100100
git clone https://github.com/linuxserver/docker-code-server.git
101101
cd docker-code-server
102102
docker build \
@@ -106,13 +106,14 @@ docker build \
106106
```
107107

108108
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
109-
```
109+
110+
```bash
110111
docker run --rm --privileged multiarch/qemu-user-static:register --reset
111112
```
112113

113114
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
114115

115-
## Update the chagelog
116+
## Update the changelog
116117

117118
If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-code-server/tree/master/root), add an entry to the changelog
118119

README.md

Lines changed: 37 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2-
<!-- Please read the CONTRIBUTING.md -->
2+
<!-- Please read the https://github.com/linuxserver/docker-code-server/blob/master/.github/CONTRIBUTING.md -->
33

44
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
55

@@ -12,13 +12,14 @@
1212

1313
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
1414

15-
* regular and timely application updates
16-
* easy user mappings (PGID, PUID)
17-
* custom base image with s6 overlay
18-
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
19-
* regular security updates
15+
* regular and timely application updates
16+
* easy user mappings (PGID, PUID)
17+
* custom base image with s6 overlay
18+
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
19+
* regular security updates
2020

2121
Find us at:
22+
2223
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
2324
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
2425
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
@@ -71,6 +72,21 @@ This image provides various versions that are available via tags. `latest` tag u
7172
| latest | Stable releases |
7273
| development | DEPRECATED (no longer updated) - Prereleases from their GitHub |
7374

75+
## Application Setup
76+
77+
Access the webui at `http://<your-ip>:8443`.
78+
For github integration, drop your ssh key in to `/config/.ssh`.
79+
Then open a terminal from the top menu and set your github username and email via the following commands
80+
81+
```bash
82+
git config --global user.name "username"
83+
git config --global user.email "email address"
84+
```
85+
86+
### Hashed code-server password
87+
88+
How to create the [hashed password](https://github.com/cdr/code-server/blob/master/docs/FAQ.md#can-i-store-my-password-hashed).
89+
7490
## Usage
7591

7692
Here are some example snippets to help you get started creating a container.
@@ -104,7 +120,7 @@ services:
104120
105121
### docker cli
106122
107-
```
123+
```bash
108124
docker run -d \
109125
--name=code-server \
110126
-e PUID=1000 \
@@ -121,7 +137,6 @@ docker run -d \
121137
ghcr.io/linuxserver/code-server
122138
```
123139

124-
125140
## Parameters
126141

127142
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.
@@ -145,7 +160,7 @@ You can set any environment variable from a file by using a special prepend `FIL
145160

146161
As an example:
147162

148-
```
163+
```bash
149164
-e FILE__PASSWORD=/run/secrets/mysecretpassword
150165
```
151166

@@ -164,35 +179,17 @@ Ensure any volume directories on the host are owned by the same user you specify
164179

165180
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
166181

167-
```
182+
```bash
168183
$ id username
169184
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
170185
```
171186

172-
173-
&nbsp;
174-
## Application Setup
175-
176-
Access the webui at `http://<your-ip>:8443`.
177-
For github integration, drop your ssh key in to `/config/.ssh`.
178-
Then open a terminal from the top menu and set your github username and email via the following commands
179-
180-
```bash
181-
git config --global user.name "username"
182-
git config --global user.email "email address"
183-
```
184-
185-
### Hashed code-server password
186-
187-
How to create the [hashed password](https://github.com/cdr/code-server/blob/master/docs/FAQ.md#can-i-store-my-password-hashed).
188-
189-
190187
## Docker Mods
188+
191189
[![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.")
192190

193191
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.
194192

195-
196193
## Support Info
197194

198195
* Shell access whilst the container is running: `docker exec -it code-server /bin/bash`
@@ -209,38 +206,45 @@ Most of our images are static, versioned, and require an image update and contai
209206
Below are the instructions for updating containers:
210207

211208
### Via Docker Compose
209+
212210
* Update all images: `docker-compose pull`
213211
* or update a single image: `docker-compose pull code-server`
214212
* Let compose update all containers as necessary: `docker-compose up -d`
215213
* or update a single container: `docker-compose up -d code-server`
216214
* You can also remove the old dangling images: `docker image prune`
217215

218216
### Via Docker Run
217+
219218
* Update the image: `docker pull ghcr.io/linuxserver/code-server`
220219
* Stop the running container: `docker stop code-server`
221220
* Delete the container: `docker rm code-server`
222221
* 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)
223222
* You can also remove the old dangling images: `docker image prune`
224223

225224
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
225+
226226
* Pull the latest image at its tag and replace it with the same env variables in one run:
227-
```
227+
228+
```bash
228229
docker run --rm \
229230
-v /var/run/docker.sock:/var/run/docker.sock \
230231
containrrr/watchtower \
231232
--run-once code-server
232233
```
234+
233235
* You can also remove the old dangling images: `docker image prune`
234236

235237
**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).
236238

237239
### Image Update Notifications - Diun (Docker Image Update Notifier)
240+
238241
* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
239242

240243
## Building locally
241244

242245
If you want to make local modifications to these images for development purposes or just to customize the logic:
243-
```
246+
247+
```bash
244248
git clone https://github.com/linuxserver/docker-code-server.git
245249
cd docker-code-server
246250
docker build \
@@ -250,7 +254,8 @@ docker build \
250254
```
251255

252256
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
253-
```
257+
258+
```bash
254259
docker run --rm --privileged multiarch/qemu-user-static:register --reset
255260
```
256261

0 commit comments

Comments
 (0)