Skip to content

Commit e73c10a

Browse files
committed
change README style and update changelog
1 parent d1e4ba4 commit e73c10a

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
![https://linuxserver.io](https://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png)
22

3-
The [LinuxServer.io](https://linuxserver.io) team brings you another quality container release featuring easy user mapping and community support. Be sure to checkout our [forums](https://forum.linuxserver.io) or for real-time support our [IRC](https://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io`.
3+
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring auto-update on startup, easy user mapping and community support. Find us for support at:
4+
* [forum.linuxserver.io](https://forum.linuxserver.io)
5+
* [IRC](https://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io`
6+
* [Podcast](https://www.linuxserver.io/index.php/category/podcast/) covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
47

58
# linuxserver/mariadb
69

@@ -27,13 +30,16 @@ linuxserver/mariadb
2730
* `-e PGID` for GroupID - see below for explanation
2831
* `-e PUID` for UserID - see below for explanation
2932

30-
It is based on phusion-baseimage with ssh removed, for shell access whilst the container is running do `docker exec -it mariadb /bin/bash`.
31-
3233
### User / Group Identifiers
3334

34-
**TL;DR** - The `PGID` and `PUID` values set the user / group you'd like your container to 'run as' to the host OS. This can be a user you've created or even root (not recommended).
35+
Sometimes when using data 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`. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
3536

36-
Part of what makes our containers work so well is by allowing you to specify your own `PUID` and `PGID`. This avoids nasty permissions errors with relation to data volumes (`-v` flags). When an application is installed on the host OS it is normally added to the common group called users, Docker apps due to the nature of the technology can't be added to this group. So we added this feature to let you easily choose when running your containers.
37+
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
38+
39+
```
40+
$ id <dockeruser>
41+
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
42+
```
3743

3844
## Setting up the application
3945

@@ -45,13 +51,16 @@ The container also has mysqltuner included which can either be run from within t
4551

4652

4753

48-
## Logs
54+
## Logs and Shell
4955

50-
* To monitor the logs of the container in realtime `docker logs -f mariadb`.
56+
* Shell access whilst the container is running: `docker exec -it mariadb /bin/bash`
57+
* To monitor the logs of the container in realtime: `docker logs -f mariadb`
5158

5259

5360

5461
## Versions
62+
+ **09.03.2016:** Change to use custom.cnf over my.cnf in /config. Restructured init files to change config options on startup, rather than in the dockerfile.
5563
+ **26.01.2016:** Change user of mysqld_safe script to abc, better unclean shutdown handling on restart.
5664
+ **23.12.2015:** Remove autoupdating, between some version updates the container breaks
5765
+ **12.08.2015:** Initial Release.
66+

0 commit comments

Comments
 (0)