Skip to content

Commit 8e3c420

Browse files
Bot Updating Templated Files
1 parent 2c8da06 commit 8e3c420

File tree

2 files changed

+31
-26
lines changed

2 files changed

+31
-26
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-sqlitebrowser.git
101101
cd docker-sqlitebrowser
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-sqlitebrowser/tree/master/root), add an entry to the changelog
118119

README.md

Lines changed: 27 additions & 23 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-sqlitebrowser/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.
@@ -56,6 +57,11 @@ The architectures supported by this image are:
5657
| arm64 | arm64v8-latest |
5758
| armhf | arm32v7-latest |
5859

60+
## Application Setup
61+
62+
The application can be accessed at:
63+
64+
* http://yourhost:3000/
5965

6066
## Usage
6167

@@ -85,7 +91,7 @@ services:
8591
8692
### docker cli
8793
88-
```
94+
```bash
8995
docker run -d \
9096
--name=sqlitebrowser \
9197
-e PUID=1000 \
@@ -97,7 +103,6 @@ docker run -d \
97103
ghcr.io/linuxserver/sqlitebrowser
98104
```
99105

100-
101106
## Parameters
102107

103108
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.
@@ -116,7 +121,7 @@ You can set any environment variable from a file by using a special prepend `FIL
116121

117122
As an example:
118123

119-
```
124+
```bash
120125
-e FILE__PASSWORD=/run/secrets/mysecretpassword
121126
```
122127

@@ -135,26 +140,17 @@ Ensure any volume directories on the host are owned by the same user you specify
135140

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

138-
```
143+
```bash
139144
$ id username
140145
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
141146
```
142147

143-
144-
&nbsp;
145-
## Application Setup
146-
147-
The application can be accessed at:
148-
149-
* http://yourhost:3000/
150-
151-
152148
## Docker Mods
149+
153150
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=sqlitebrowser&query=%24.mods%5B%27sqlitebrowser%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=sqlitebrowser "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.")
154151

155152
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.
156153

157-
158154
## Support Info
159155

160156
* Shell access whilst the container is running: `docker exec -it sqlitebrowser /bin/bash`
@@ -171,38 +167,45 @@ Most of our images are static, versioned, and require an image update and contai
171167
Below are the instructions for updating containers:
172168

173169
### Via Docker Compose
170+
174171
* Update all images: `docker-compose pull`
175172
* or update a single image: `docker-compose pull sqlitebrowser`
176173
* Let compose update all containers as necessary: `docker-compose up -d`
177174
* or update a single container: `docker-compose up -d sqlitebrowser`
178175
* You can also remove the old dangling images: `docker image prune`
179176

180177
### Via Docker Run
178+
181179
* Update the image: `docker pull ghcr.io/linuxserver/sqlitebrowser`
182180
* Stop the running container: `docker stop sqlitebrowser`
183181
* Delete the container: `docker rm sqlitebrowser`
184182
* 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)
185183
* You can also remove the old dangling images: `docker image prune`
186184

187185
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
186+
188187
* Pull the latest image at its tag and replace it with the same env variables in one run:
189-
```
188+
189+
```bash
190190
docker run --rm \
191191
-v /var/run/docker.sock:/var/run/docker.sock \
192192
containrrr/watchtower \
193193
--run-once sqlitebrowser
194194
```
195+
195196
* You can also remove the old dangling images: `docker image prune`
196197

197198
**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).
198199

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

202204
## Building locally
203205

204206
If you want to make local modifications to these images for development purposes or just to customize the logic:
205-
```
207+
208+
```bash
206209
git clone https://github.com/linuxserver/docker-sqlitebrowser.git
207210
cd docker-sqlitebrowser
208211
docker build \
@@ -212,7 +215,8 @@ docker build \
212215
```
213216

214217
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
215-
```
218+
219+
```bash
216220
docker run --rm --privileged multiarch/qemu-user-static:register --reset
217221
```
218222

0 commit comments

Comments
 (0)