Skip to content

Commit 1fe0966

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent a67dc27 commit 1fe0966

File tree

1 file changed

+101
-35
lines changed

1 file changed

+101
-35
lines changed

‎README.md‎

Lines changed: 101 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2-
<!-- Please read the https://github.com/linuxserver/docker-openvscode-server/blob/insiders/.github/CONTRIBUTING.md -->
3-
1+
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2+
<!-- Please read https://github.com/linuxserver/docker-openvscode-server/blob/insiders/.github/CONTRIBUTING.md -->
43
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
54

65
[![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
@@ -66,6 +65,7 @@ This image provides various versions that are available via tags. Please read th
6665
| :----: | :----: |--- |
6766
| latest | ✅ | Stable releases |
6867
| insiders | ✅ | Insiders releases |
68+
6969
## Application Setup
7070

7171
If `CONNECTION_TOKEN` or `CONNECTION_SECRET` env vars are set, you can access the webui at `http://<your-ip>:3000/?tkn=supersecrettoken` (replace `supersecrettoken` with the value set). If not, you can access the webui at `http://<your-ip>:3000`.
@@ -82,7 +82,7 @@ When reverse proxied through SWAG, custom services running on specific ports ins
8282

8383
## Usage
8484

85-
Here are some example snippets to help you get started creating a container.
85+
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
8686

8787
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
8888

@@ -124,12 +124,11 @@ docker run -d \
124124
-v /path/to/appdata/config:/config \
125125
--restart unless-stopped \
126126
lscr.io/linuxserver/openvscode-server:insiders
127-
128127
```
129128

130129
## Parameters
131130

132-
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.
131+
Containers 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.
133132

134133
| Parameter | Function |
135134
| :----: | --- |
@@ -150,10 +149,10 @@ You can set any environment variable from a file by using a special prepend `FIL
150149
As an example:
151150

152151
```bash
153-
-e FILE__PASSWORD=/run/secrets/mysecretpassword
152+
-e FILE__MYVAR=/run/secrets/mysecretvariable
154153
```
155154

156-
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
155+
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
157156

158157
## Umask for running applications
159158

@@ -162,15 +161,20 @@ Keep in mind umask is not chmod it subtracts from permissions based on it's valu
162161

163162
## User / Group Identifiers
164163

165-
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`.
164+
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`.
166165

167166
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
168167

169-
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
168+
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
170169

171170
```bash
172-
$ id username
173-
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
171+
id your_user
172+
```
173+
174+
Example output:
175+
176+
```text
177+
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
174178
```
175179

176180
## Docker Mods
@@ -181,12 +185,29 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
181185

182186
## Support Info
183187

184-
* Shell access whilst the container is running: `docker exec -it openvscode-server /bin/bash`
185-
* To monitor the logs of the container in realtime: `docker logs -f openvscode-server`
186-
* container version number
187-
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' openvscode-server`
188-
* image version number
189-
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/openvscode-server:insiders`
188+
* Shell access whilst the container is running:
189+
190+
```bash
191+
docker exec -it openvscode-server /bin/bash
192+
```
193+
194+
* To monitor the logs of the container in realtime:
195+
196+
```bash
197+
docker logs -f openvscode-server
198+
```
199+
200+
* Container version number:
201+
202+
```bash
203+
docker inspect -f '{{ index .Config.Labels "build_version" }}' openvscode-server
204+
```
205+
206+
* Image version number:
207+
208+
```bash
209+
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/openvscode-server:insiders
210+
```
190211

191212
## Updating Info
192213

@@ -196,38 +217,83 @@ Below are the instructions for updating containers:
196217

197218
### Via Docker Compose
198219

199-
* Update all images: `docker-compose pull`
200-
* or update a single image: `docker-compose pull openvscode-server`
201-
* Let compose update all containers as necessary: `docker-compose up -d`
202-
* or update a single container: `docker-compose up -d openvscode-server`
203-
* You can also remove the old dangling images: `docker image prune`
220+
* Update images:
221+
* All images:
222+
223+
```bash
224+
docker-compose pull
225+
```
226+
227+
* Single image:
228+
229+
```bash
230+
docker-compose pull openvscode-server
231+
```
232+
233+
* Update containers:
234+
* All containers:
235+
236+
```bash
237+
docker-compose up -d
238+
```
239+
240+
* Single container:
241+
242+
```bash
243+
docker-compose up -d openvscode-server
244+
```
245+
246+
* You can also remove the old dangling images:
247+
248+
```bash
249+
docker image prune
250+
```
204251

205252
### Via Docker Run
206253

207-
* Update the image: `docker pull lscr.io/linuxserver/openvscode-server:insiders`
208-
* Stop the running container: `docker stop openvscode-server`
209-
* Delete the container: `docker rm openvscode-server`
254+
* Update the image:
255+
256+
```bash
257+
docker pull lscr.io/linuxserver/openvscode-server:insiders
258+
```
259+
260+
* Stop the running container:
261+
262+
```bash
263+
docker stop openvscode-server
264+
```
265+
266+
* Delete the container:
267+
268+
```bash
269+
docker rm openvscode-server
270+
```
271+
210272
* 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)
211-
* You can also remove the old dangling images: `docker image prune`
273+
* You can also remove the old dangling images:
274+
275+
```bash
276+
docker image prune
277+
```
212278

213279
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
214280

215281
* Pull the latest image at its tag and replace it with the same env variables in one run:
216282

217-
```bash
218-
docker run --rm \
219-
-v /var/run/docker.sock:/var/run/docker.sock \
220-
containrrr/watchtower \
221-
--run-once openvscode-server
222-
```
283+
```bash
284+
docker run --rm \
285+
-v /var/run/docker.sock:/var/run/docker.sock \
286+
containrrr/watchtower \
287+
--run-once openvscode-server
288+
```
223289

224290
* You can also remove the old dangling images: `docker image prune`
225291

226-
**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).
292+
**warning**: 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).
227293

228294
### Image Update Notifications - Diun (Docker Image Update Notifier)
229295

230-
* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
296+
**tip**: We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
231297

232298
## Building locally
233299

0 commit comments

Comments
 (0)