Merge pull request #387 from Paraphraser/20210809-nextcloud-mariadb-master

20210809 MariaDB + Nextcloud - master branch - PR 1 of 3

Author: Slyke

.templates/mariadb/Dockerfile

@@ -0,0 +1,13 @@
+# Download base image
+FROM ghcr.io/linuxserver/mariadb
+
+# apply stability patches recommended in
+#   
+#   https://discord.com/channels/638610460567928832/638610461109256194/825049573520965703
+#   https://stackoverflow.com/questions/61809270/how-to-discover-why-mariadb-crashes
+RUN sed -i.bak \
+  -e "s/^thread_cache_size/# thread_cache_size/" \
+  -e "s/^read_buffer_size/# read_buffer_size/" \
+  /defaults/my.cnf
+
+# EOF

.templates/mariadb/service.yml

@@ -1,5 +1,5 @@
 mariadb:
-  image: linuxserver/mariadb
+  build: ./.templates/mariadb/.
   container_name: mariadb
   environment:
     - TZ=Etc/UTC
@@ -11,6 +11,7 @@ mariadb:
     - MYSQL_PASSWORD=%randomPassword%
   volumes:
     - ./volumes/mariadb/config:/config
+    - ./volumes/mariadb/db_backup:/backup
   ports:
     - "3306:3306"
   restart: unless-stopped

.templates/nextcloud/service.yml

@@ -19,7 +19,7 @@ nextcloud:
 
 nextcloud_db:
   container_name: nextcloud_db
-  image: ghcr.io/linuxserver/mariadb
+  build: ./.templates/mariadb/.
   restart: unless-stopped
   environment:
     - TZ=Etc/UTC
@@ -29,7 +29,10 @@ nextcloud_db:
     - MYSQL_PASSWORD=%randomMySqlPassword%
     - MYSQL_DATABASE=nextcloud
     - MYSQL_USER=nextcloud
+  ports:
+    - "9322:3306"
   volumes:
     - ./volumes/nextcloud/db:/config
+    - ./volumes/nextcloud/db_backup:/backup
   networks:
     - nextcloud_internal

docs/Containers/MariaDB.md

@@ -4,20 +4,75 @@
 
 ## About
 
-MariaDB is a fork of MySQL. This is an unofficial image provided by linuxserver.io because there is no official image for arm
+MariaDB is a fork of MySQL. This is an unofficial image provided by linuxserver.io because there is no official image for arm.
 
-## Conneting to the DB
+## Connecting to the DB
 
 The port is 3306. It exists inside the docker network so you can connect via `mariadb:3306` for internal connections. For external connections use `<your Pis IP>:3306`
 
 ![image](https://user-images.githubusercontent.com/46672225/69734358-7f030800-1137-11ea-9874-7d2c86b3d239.png)
 
 ## Setup
 
-Before starting the stack edit the `./services/mariadb/mariadb.env` file and set your access details. This is optional however you will only have one shot at the preconfig. If you start the container without setting the passwords then you will have to either delete its volume directory or enter the terminal and change manually
+Before starting the stack, edit the `docker-compose.yml` file and check your environment variables. In particular:
 
-The env file has three commented fields for credentials, either **all three** must be commented or un-commented. You can't have only one or two, its all or nothing.
+```
+  environment:
+    - TZ=Etc/UTC
+    - MYSQL_ROOT_PASSWORD=
+    - MYSQL_DATABASE=default
+    - MYSQL_USER=mariadbuser
+    - MYSQL_PASSWORD=
+```
+
+If you are running old-menu, you will have to set both passwords. Under new-menu, the menu may have allocated random passwords for you but you can change them if you like.
+
+You only get the opportunity to change the `MQSL_` prefixed environment variables before you bring up the container for the first time. If you decide to change these values after initialisation, you will either have to:
+
+1. Erase the persistent storage area and start again. There are three steps:
+
+	* Stop the container and remove the persistent storage area:
+
+		```
+		$ cd ~/IOTstack
+		$ docker-compose rm --force --stop -v mariadb
+		$ sudo rm -rf ./volumes/mariadb
+		```
+		
+	* Edit `docker-compose.yml` and change the variables.
+	* Bring up the container:
+	
+		```
+		$ docker-compose up -d mariadb 
+		```
+
+2. Open a terminal window within the container (see below) and change the values by hand.
+
+	> The how-to is beyond the scope of this documentation. Google is your friend!
 
 ## Terminal
 
-A terminal is provided to access mariadb by the cli. execute `./services/mariadb/terminal.sh`. You will need to run `mysql -uroot -p` to enter mariadbs interface
+You can open a terminal session within the mariadb container via:
+
+```
+$ docker exec -it mariadb bash
+```
+
+To close the terminal session, either:
+
+* type "exit" and press <kbd>return</kbd>; or
+* press <kbd>control</kbd>+<kbd>d</kbd>.
+
+## Keeping MariaDB up-to-date
+
+To update the `mariadb` container:
+
+```
+$ cd ~/IOTstack
+$ docker-compose build --no-cache --pull mariadb
+$ docker-compose up -d mariadb
+$ docker system prune
+$ docker system prune
+```
+
+The first "prune" removes the old *local* image, the second removes the old *base* image.

docs/Containers/NextCloud.md

@@ -23,7 +23,7 @@ nextcloud:
 
 nextcloud_db:
   container_name: nextcloud_db
-  image: ghcr.io/linuxserver/mariadb
+  build: ./.templates/mariadb/.
   restart: unless-stopped
   environment:
     - TZ=Etc/UTC
@@ -33,8 +33,11 @@ nextcloud_db:
     - MYSQL_PASSWORD=«user_password»
     - MYSQL_DATABASE=nextcloud
     - MYSQL_USER=nextcloud
+  ports:
+    - "9322:3306"
   volumes:
     - ./volumes/nextcloud/db:/config
+    - ./volumes/nextcloud/db_backup:/backup
 ```
 
 There are two containers, one for the cloud service itself, and the other for the database. Both containers share the same persistent storage area in the volumes subdirectory so they are treated as a unit. This will not interfere with any other MariaDB containers you might wish to run.
@@ -259,6 +262,29 @@ You can silence the warning by editing the Nextcloud service definition in `dock
 
 Nextcloud traffic is not encrypted. Do **not** expose it to the web by opening a port on your home router. Instead, use a VPN like Wireguard to provide secure access to your home network, and let your remote clients access Nextcloud over the VPN tunnel.
 
+## <a name="updatingNextcloud"> Keeping Nextcloud up-to-date </a>
+
+To update the `nextcloud` container:
+
+```
+$ cd ~/IOTstack
+$ docker-compose pull nextcloud
+$ docker-compose up -d nextcloud
+$ docker system prune
+```
+
+To update the `nextcloud_db` container:
+
+```
+$ cd ~/IOTstack
+$ docker-compose build --no-cache --pull nextcloud_db
+$ docker-compose up -d nextcloud_db
+$ docker system prune
+$ docker system prune
+```
+
+The first "prune" removes the old *local* image, the second removes the old *base* image.
+
 ## <a name="backups"> Backups </a>
 
 Nextcloud is currently excluded from the IOTstack-supplied backup scripts due to its potential size.