Skip to content

Commit 15fd5fb

Browse files
Bot Updating Templated Files
1 parent 91a431e commit 15fd5fb

File tree

2 files changed

+36
-31
lines changed

2 files changed

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

README.md

Lines changed: 32 additions & 28 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-mysql-workbench/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.
@@ -44,7 +45,7 @@ Find us at:
4445

4546
## Supported Architectures
4647

47-
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
48+
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
4849

4950
Simply pulling `ghcr.io/linuxserver/mysql-workbench` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
5051

@@ -54,6 +55,15 @@ The architectures supported by this image are:
5455
| :----: | --- |
5556
| x86-64 | latest |
5657

58+
## Application Setup
59+
60+
The application can be accessed at:
61+
62+
* http://yourhost:3000/
63+
64+
By default the user/pass is abc/abc, if you change your password or want to login manually to the GUI session for any reason use the following link:
65+
66+
* http://yourhost:3000/?login=true
5767

5868
## Usage
5969

@@ -85,7 +95,7 @@ services:
8595
8696
### docker cli
8797
88-
```
98+
```bash
8999
docker run -d \
90100
--name=mysql-workbench \
91101
-e PUID=1000 \
@@ -98,7 +108,6 @@ docker run -d \
98108
ghcr.io/linuxserver/mysql-workbench
99109
```
100110

101-
102111
## Parameters
103112

104113
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.
@@ -118,7 +127,7 @@ You can set any environment variable from a file by using a special prepend `FIL
118127

119128
As an example:
120129

121-
```
130+
```bash
122131
-e FILE__PASSWORD=/run/secrets/mysecretpassword
123132
```
124133

@@ -137,30 +146,17 @@ Ensure any volume directories on the host are owned by the same user you specify
137146

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

140-
```
149+
```bash
141150
$ id username
142151
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
143152
```
144153

145-
146-
&nbsp;
147-
## Application Setup
148-
149-
The application can be accessed at:
150-
151-
* http://yourhost:3000/
152-
153-
By default the user/pass is abc/abc, if you change your password or want to login manually to the GUI session for any reason use the following link:
154-
155-
* http://yourhost:3000/?login=true
156-
157-
158154
## Docker Mods
155+
159156
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=mysql-workbench&query=%24.mods%5B%27mysql-workbench%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=mysql-workbench "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.")
160157

161158
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.
162159

163-
164160
## Support Info
165161

166162
* Shell access whilst the container is running: `docker exec -it mysql-workbench /bin/bash`
@@ -177,38 +173,45 @@ Most of our images are static, versioned, and require an image update and contai
177173
Below are the instructions for updating containers:
178174

179175
### Via Docker Compose
176+
180177
* Update all images: `docker-compose pull`
181178
* or update a single image: `docker-compose pull mysql-workbench`
182179
* Let compose update all containers as necessary: `docker-compose up -d`
183180
* or update a single container: `docker-compose up -d mysql-workbench`
184181
* You can also remove the old dangling images: `docker image prune`
185182

186183
### Via Docker Run
184+
187185
* Update the image: `docker pull ghcr.io/linuxserver/mysql-workbench`
188186
* Stop the running container: `docker stop mysql-workbench`
189187
* Delete the container: `docker rm mysql-workbench`
190188
* 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)
191189
* You can also remove the old dangling images: `docker image prune`
192190

193191
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
192+
194193
* Pull the latest image at its tag and replace it with the same env variables in one run:
195-
```
194+
195+
```bash
196196
docker run --rm \
197197
-v /var/run/docker.sock:/var/run/docker.sock \
198198
containrrr/watchtower \
199199
--run-once mysql-workbench
200200
```
201+
201202
* You can also remove the old dangling images: `docker image prune`
202203

203204
**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).
204205

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

208210
## Building locally
209211

210212
If you want to make local modifications to these images for development purposes or just to customize the logic:
211-
```
213+
214+
```bash
212215
git clone https://github.com/linuxserver/docker-mysql-workbench.git
213216
cd docker-mysql-workbench
214217
docker build \
@@ -218,7 +221,8 @@ docker build \
218221
```
219222

220223
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
221-
```
224+
225+
```bash
222226
docker run --rm --privileged multiarch/qemu-user-static:register --reset
223227
```
224228

0 commit comments

Comments
 (0)