Upgrade Nextcloud setup to use compose files

- Integrated MariaDB role into Dockerbox configuration
- Moved proxy role to the end to avoid early endpoint activation
- Temporarily disabled select roles for future re-evaluation
- Introduced flush_handlers task for early MariaDB restart
- Moved a few Nextcloud tasks to handlers
- Configured Nextcloud to utilize the host's MariaDB instance
- Enhanced overall code linting quality

README.md

@@ -1,41 +1,76 @@
-# Project Moxie
+# Homelab
 
-Project Moxie is a personal IT homelab project written in Ansible and executed by Jenkins. It is a growing collection of infrastructure as code (IaC) I write out of curiosity and for reference purposes, keeping a handful of beneficial projects managed and secured.
+This project is my personal IT homelab initiative for self-hosting and
+exploring Free and Open Source Software (FOSS) infrastructure. As a technology
+enthusiast and professional, this project is primarily a practical tool for
+hosting services. It serves as a playground for engaging with systems
+technology in functional, intriguing, and gratifying ways. Self-hosting
+empowers individuals to govern their digital space, ensuring that their online
+environments reflect personal ethics rather than centralized entities' opaque
+policies.
+
+Built on Debian Stable, this project utilizes Ansible and Vagrant, providing
+relatively easy-to-use reproducible ephemeral environments to test
+infrastructure automation before pushing to live systems.
 
 ## Quick Start
 
 To configure a local virtual machine for testing, follow these simple steps.
 
-### Prerequisites
-
-Vagrant and VirtualBox are used to develop Project Moxie. You will need to install these before continuing.
-
 ### Installation
 
 1. Clone this repository
    ```
-   git clone https://github.com/krislamo/moxie
+   git clone https://git.krislamo.org/kris/homelab
+   ```
+   Optionally clone from the GitHub mirror instead:
+   ```
+   git clone https://github.com/krislamo/homelab
    ```
 2. Set the `PLAYBOOK` environmental variable to a development playbook name in the `dev/` directory
 
-   The following `PLAYBOOK` names are available: `dockerbox`, `hypervisor`, `minecraft`, `bitwarden`, `nextcloud`, `nginx`
-
+   To list available options in the `dev/` directory and choose a suitable PLAYBOOK, run:
+   ```
+   ls dev/*.yml | xargs -n 1 basename -s .yml
+   ```
+   Export the `PLAYBOOK` variable
    ```
    export PLAYBOOK=dockerbox
    ```
-3. Bring the Vagrant box up
+3. Clean up any previous provision and build the VM
    ```
-   vagrant up
+   make clean && make
    ```
 
-#### Copyright and License
-Copyright (C) 2020-2021  Kris Lamoureux
+## Vagrant Settings
+The Vagrantfile configures the environment based on settings from `.vagrant.yml`,
+with default values including:
+
+- PLAYBOOK: `default`
+   - Runs a `default` playbook that does nothing.
+   - You can set this by an environmental variable with the same name.
+- VAGRANT_BOX: `debian/bookworm64`
+   - Current Debian Stable codename
+- VAGRANT_CPUS: `2`
+   - Threads or cores per node, depending on CPU architecture
+- VAGRANT_MEM: `2048`
+   - Specifies the amount of memory (in MB) allocated
+- SSH_FORWARD: `false`
+   - Enable this if you need to forward SSH agents to the Vagrant machine
+
+
+## Copyright and License
+Copyright (C) 2019-2023  Kris Lamoureux
 
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation, version 3 of the License.
 
-This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 of the License.
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 
-This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
+You should have received a copy of the GNU General Public License along with
+this program. If not, see <https://www.gnu.org/licenses/>.

dev/dockerbox.yml

@@ -6,8 +6,7 @@
   roles:
     - base
     - docker
+    - mariadb
     - traefik
     - nextcloud
-    - jenkins
-    - prometheus
-    - nginx
+    - proxy

dev/host_vars/dockerbox.yml

@@ -2,44 +2,47 @@
 allow_reboot: false
 manage_network: false
 
+# Import my GPG key for git signature verification
+root_gpgkeys:
+  - name: kris@lamoureux.io
+    id: FBF673CEEC030F8AECA814E73EDA9C3441EDA925
+
+# proxy
+proxy:
+  servers:
+    - domain: cloud.local.krislamo.org
+      proxy_pass: http://127.0.0.1:8000
+
 # docker
+docker_official: true # docker's apt repos
 docker_users:
   - vagrant
 
+docker_compose_env_nolog: false # dev only setting
+docker_compose_deploy:
+  # Traefik
+  - name: traefik
+    url: https://github.com/krislamo/traefik
+    version: d62bd06b37ecf0993962b0449a9d708373f9e381
+    enabled: true
+    accept_newhostkey: true # Consider verifying manually instead
+    trusted_keys:
+      - FBF673CEEC030F8AECA814E73EDA9C3441EDA925
+    env:
+      DASHBOARD: true
+  # Nextcloud
+  - name: nextcloud
+    url: https://github.com/krislamo/nextcloud
+    version: 0abc5cc6ba64ed94b7ddc6fd934f0fd62b8a6d11
+    env:
+      DATA: ./data
+
 # traefik
-traefik_version: latest
-traefik_dashboard: true
-traefik_domain: traefik.local.krislamo.org
-traefik_auth: admin:$apr1$T1l.BCFz$Jyg8msXYEAUi3LLH39I9d1 # admin:admin
-traefik_web_entry: 0.0.0.0:80
-traefik_websecure_entry: 0.0.0.0:443
-#traefik_acme_email: realemail@example.com # Let's Encrypt settings
-#traefik_production: true
-#traefik_http_only: true # if behind reverse-proxy
+traefik:
+  ENABLE: true
 
 # nextcloud
-nextcloud_version: stable
-nextcloud_admin: admin
-nextcloud_pass: password
-nextcloud_domain: cloud.local.krislamo.org
-
-nextcloud_dbversion: latest
-nextcloud_dbpass: password
-
-# jenkins
-jenkins_version: lts
-jenkins_domain: jenkins.local.krislamo.org
-
-# prometheus (includes grafana)
-prom_version: latest
-prom_domain: prom.local.krislamo.org
-grafana_version: latest
-grafana_domain: grafana.local.krislamo.org
-prom_targets: "['10.0.2.15:9100']"
-
-# nginx
-nginx_domain: nginx.local.krislamo.org
-nginx_name: staticsite
-nginx_repo_url: https://git.krislamo.org/kris/example-website/
-nginx_auth: admin:$apr1$T1l.BCFz$Jyg8msXYEAUi3LLH39I9d1 # admin:admin
-nginx_version: latest
+nextcloud:
+  DOMAIN: cloud.local.krislamo.org
+  DB_PASSWD: password
+  ADMIN_PASSWD: password

forward-ssh.sh

@@ -22,7 +22,7 @@
 
 # Root check
 if [ "$EUID" -ne 0 ]; then
-  echo "[ERROR]: Please run script as root"
+  echo "[ERROR]: Please run this script as root"
   exit 1
 fi
 
@@ -41,8 +41,8 @@ function ssh_connect {
       printf "[INFO]: Starting new vagrant SSH tunnel on PID "
       sudo -u "$USER" ssh -fNT -i "$PRIVATE_KEY" \
         -L 22:localhost:22 \
-        -L 80:localhost:80 \
-        -L 443:localhost:443 \
+        -L 80:"$HOST_IP":80 \
+        -L 443:"$HOST_IP":443 \
         -L 8443:localhost:8443 \
         -o UserKnownHostsFile=/dev/null \
         -o StrictHostKeyChecking=no \
@@ -51,7 +51,7 @@ function ssh_connect {
       pgrep -f "$MATCH_PATTERN"
       ;;
     *)
-      echo "[INFO]: Delined to start a new vagrant SSH tunnel"
+      echo "[INFO]: Declined to start a new vagrant SSH tunnel"
       exit 0
       ;;
   esac
@@ -64,7 +64,7 @@ PRIVATE_KEY="$(find .vagrant -name "private_key" 2>/dev/null | sort)"
 if [ "$(echo "$PRIVATE_KEY" | wc -l)" -gt 1 ]; then
   while IFS= read -r KEYFILE; do
     if ! ssh-keygen -l -f "$KEYFILE" &>/dev/null; then
-      echo "[ERROR]: The SSH key '$KEYFILE' is not valid. Is your virtual machines running?"
+      echo "[ERROR]: The SSH key '$KEYFILE' is not valid. Are your virtual machines running?"
       exit 1
     fi
     echo "[CHECK]: Valid key at $KEYFILE"
@@ -78,7 +78,7 @@ else
 fi
 
 # Grab first IP or use whatever HOST_IP_FIELD is set to and check that the guest is up
-HOST_IP="$(vagrant ssh -c "hostname -I | cut -d' ' -f${HOST_IP_FIELD:-1}" "${1:-default}" 2>/dev/null)"
+HOST_IP="$(sudo -u "$SUDO_USER" vagrant ssh -c "hostname -I | cut -d' ' -f${HOST_IP_FIELD:-1}" "${1:-default}" 2>/dev/null)"
 if [ -z "$HOST_IP" ]; then
   echo "[ERROR]: Failed to find ${1:-default}'s IP"
   exit 1

roles/mariadb/tasks/main.yml

@@ -17,6 +17,10 @@
     line: "bind-address            = {{ ansible_facts.docker0.ipv4.address }}"
   notify: restart_mariadb
 
+- name: Flush handlers to ensure MariaDB restarts immediately
+  ansible.builtin.meta: flush_handlers
+  tags: restart_mariadb
+
 - name: Allow database connections from Docker
   community.general.ufw:
     rule: allow

roles/nextcloud/defaults/main.yml

@@ -1,11 +1 @@
-# container names
-nextcloud_container: nextcloud
-nextcloud_dbcontainer: "{{ nextcloud_container }}-db"
-
-# database settings
-nextcloud_dbname: "{{ nextcloud_container }}"
-nextcloud_dbuser: "{{ nextcloud_dbname }}"
-
-# host mounts
-nextcloud_root: "/opt/{{ nextcloud_container }}/public_html"
-nextcloud_dbroot: "/opt/{{ nextcloud_container }}/database"
+nextcloud_name: nextcloud

roles/nextcloud/handlers/main.yml

@@ -0,0 +1,25 @@
+- name: Set Nextcloud's Trusted Proxy
+  ansible.builtin.command: >
+    docker exec --user www-data "{{ nextcloud_name }}"
+      php occ config:system:set trusted_proxies 0 --value="{{ traefik_name }}"
+  register: nextcloud_trusted_proxy
+  changed_when: "nextcloud_trusted_proxy.stdout == 'System config value trusted_proxies => 0 set to string ' ~ traefik_name"
+  listen: install_nextcloud
+
+- name: Set Nextcloud's Trusted Domain
+  ansible.builtin.command: >
+    docker exec --user www-data "{{ nextcloud_name }}"
+      php occ config:system:set trusted_domains 0 --value="{{ nextcloud.DOMAIN }}"
+  register: nextcloud_trusted_domains
+  changed_when: "nextcloud_trusted_domains.stdout == 'System config value trusted_domains => 0 set to string ' ~ nextcloud.DOMAIN"
+  listen: install_nextcloud
+
+- name: Preform Nextcloud database maintenance
+  ansible.builtin.command: >
+    docker exec --user www-data "{{ nextcloud_name }}" {{ item }}
+  loop:
+    - "php occ maintenance:mode --on"
+    - "php occ db:add-missing-indices"
+    - "php occ db:convert-filecache-bigint"
+    - "php occ maintenance:mode --off"
+  listen: install_nextcloud

roles/nextcloud/tasks/main.yml

@@ -1,109 +1,62 @@
-- name: Create Nextcloud network
-  community.general.docker_network:
-    name: "{{ nextcloud_container }}"
+- name: Install MySQL module for Ansible
+  ansible.builtin.apt:
+    name: python3-pymysql
+    state: present
 
-- name: Start Nextcloud's database container
-  community.general.docker_container:
-    name: "{{ nextcloud_dbcontainer }}"
-    image: mariadb:{{ nextcloud_dbversion }}
+- name: Create Nextcloud database
+  community.mysql.mysql_db:
+    name: "{{ nextcloud.DB_NAME | default('nextcloud') }}"
+    state: present
+    login_unix_socket: /var/run/mysqld/mysqld.sock
+
+- name: Create Nextcloud database user
+  community.mysql.mysql_user:
+    name: "{{ nextcloud.DB_USER | default('nextcloud') }}"
+    password: "{{ nextcloud.DB_PASSWD }}"
+    host: '%'
+    state: present
+    priv: "{{ nextcloud.DB_NAME | default('nextcloud') }}.*:ALL"
+    login_unix_socket: /var/run/mysqld/mysqld.sock
+
+- name: Start Nextcloud service and enable on boot
+  ansible.builtin.service:
+    name: "{{ docker_compose_service }}@{{ nextcloud_name }}"
     state: started
-    restart_policy: always
-    volumes: "{{ nextcloud_dbroot }}:/var/lib/mysql"
-    networks_cli_compatible: true
-    networks:
-      - name: "{{ nextcloud_container }}"
-    env:
-      MYSQL_RANDOM_ROOT_PASSWORD: "true"
-      MYSQL_DATABASE: "{{ nextcloud_dbname }}"
-      MYSQL_USER: "{{ nextcloud_dbuser }}"
-      MYSQL_PASSWORD: "{{ nextcloud_dbpass }}"
-
-- name: Start Nextcloud container
-  community.general.docker_container:
-    name: "{{ nextcloud_container }}"
-    image: nextcloud:{{ nextcloud_version }}
-    state: started
-    restart_policy: always
-    volumes: "{{ nextcloud_root }}:/var/www/html"
-    networks_cli_compatible: true
-    networks:
-      - name: "{{ nextcloud_container }}"
-      - name: traefik
-    env:
-      PHP_MEMORY_LIMIT: 1024M
-    labels:
-      traefik.http.routers.nextcloud.rule: "Host(`{{ nextcloud_domain }}`)"
-      traefik.http.routers.nextcloud.entrypoints: websecure
-      traefik.http.routers.nextcloud.tls.certresolver: letsencrypt
-      traefik.http.routers.nextcloud.middlewares: "securehttps@file,nextcloud-webdav"
-      traefik.http.middlewares.nextcloud-webdav.redirectregex.regex: "https://(.*)/.well-known/(card|cal)dav"
-      traefik.http.middlewares.nextcloud-webdav.redirectregex.replacement: "https://${1}/remote.php/dav/"
-      traefik.http.middlewares.nextcloud-webdav.redirectregex.permanent: "true"
-      traefik.docker.network: traefik
-      traefik.enable: "true"
-
-- name: Grab Nextcloud database container information
-  community.general.docker_container_info:
-    name: "{{ nextcloud_dbcontainer }}"
-  register: nextcloud_dbinfo
+    enabled: true
+  when: nextcloud.ENABLE | default('false')
 
 - name: Grab Nextcloud container information
   community.general.docker_container_info:
-    name: "{{ nextcloud_container }}"
+    name: "{{ nextcloud_name }}"
   register: nextcloud_info
 
 - name: Wait for Nextcloud to become available
   ansible.builtin.wait_for:
     host: "{{ nextcloud_info.container.NetworkSettings.Networks.traefik.IPAddress }}"
+    delay: 10
     port: 80
 
 - name: Check Nextcloud status
-  ansible.builtin.command: "docker exec --user www-data {{ nextcloud_container }}
-            php occ status"
+  ansible.builtin.command: >
+    docker exec --user www-data "{{ nextcloud_name }}" php occ status
   register: nextcloud_status
-  args:
-    removes: "{{ nextcloud_root }}/config/CAN_INSTALL"
-
-- name: Wait for Nextcloud database to become available
-  ansible.builtin.wait_for:
-    host: "{{ nextcloud_dbinfo.container.NetworkSettings.Networks.nextcloud.IPAddress }}"
-    port: 3306
+  changed_when: false
 
 - name: Install Nextcloud
-  ansible.builtin.command: 'docker exec --user www-data {{ nextcloud_container }}
-            php occ maintenance:install
-              --database "mysql"
-              --database-host "{{ nextcloud_dbcontainer }}"
-              --database-name "{{ nextcloud_dbname }}"
-              --database-user "{{ nextcloud_dbuser }}"
-              --database-pass "{{ nextcloud_dbpass }}"
-              --admin-user "{{ nextcloud_admin }}"
-              --admin-pass "{{ nextcloud_pass }}"'
+  ansible.builtin.command: >
+    docker exec --user www-data {{ nextcloud_name }}
+      php occ maintenance:install
+        --database "mysql"
+        --database-host "{{ nextcloud.DB_HOST | default('host.docker.internal') }}"
+        --database-name "{{ nextcloud.DB_NAME | default('nextcloud') }}"
+        --database-user "{{ nextcloud.DB_USER | default('nextcloud') }}"
+        --database-pass "{{ nextcloud.DB_PASSWD }}"
+        --admin-user "{{ nextcloud.ADMIN_USER | default('admin') }}"
+        --admin-pass "{{ nextcloud.ADMIN_PASSWD }}"
   register: nextcloud_install
-  when:
-    - nextcloud_status.stdout[:26] == "Nextcloud is not installed"
-    - nextcloud_domain is defined
-
-- name: Set Nextcloud's Trusted Proxy
-  ansible.builtin.command: 'docker exec --user www-data {{ nextcloud_container }}
-            php occ config:system:set trusted_proxies 0
-              --value="{{ traefik_name }}"'
-  when: nextcloud_install.changed
-
-- name: Set Nextcloud's Trusted Domain
-  ansible.builtin.command: 'docker exec --user www-data {{ nextcloud_container }}
-            php occ config:system:set trusted_domains 0
-              --value="{{ nextcloud_domain }}"'
-  when: nextcloud_install.changed
-
-- name: Preform Nextcloud database maintenance
-  ansible.builtin.command: "docker exec --user www-data {{ nextcloud_container }} {{ item }}"
-  loop:
-    - "php occ maintenance:mode --on"
-    - "php occ db:add-missing-indices"
-    - "php occ db:convert-filecache-bigint"
-    - "php occ maintenance:mode --off"
-  when: nextcloud_install.changed
+  when: nextcloud_status.stderr[:26] == "Nextcloud is not installed"
+  changed_when: nextcloud_install.stdout == "Nextcloud was successfully installed"
+  notify: install_nextcloud
 
 - name: Install Nextcloud background jobs cron
   ansible.builtin.cron:
@@ -111,8 +64,3 @@
     minute: "*/5"
     job: "/usr/bin/docker exec -u www-data nextcloud /usr/local/bin/php -f /var/www/html/cron.php"
     user: root
-
-- name: Remove Nextcloud's CAN_INSTALL file
-  ansible.builtin.file:
-    path: "{{ nextcloud_root }}/config/CAN_INSTALL"
-    state: absent

roles/proxy/defaults/main.yml

@@ -0,0 +1 @@
+cached_dhparams_pem: /vagrant/scratch/dhparams.pem

roles/proxy/tasks/main.yml

@@ -10,6 +10,19 @@
     state: started
     enabled: true
 
+- name: Check for cached dhparams.pem file
+  ansible.builtin.stat:
+    path: "{{ cached_dhparams_pem }}"
+  register: dhparams_file
+
+- name: Copy cached dhparams.pem to /etc/ssl/
+  ansible.builtin.copy:
+    src: "{{ cached_dhparams_pem }}"
+    dest: /etc/ssl/dhparams.pem
+    mode: "600"
+    remote_src: true
+  when: dhparams_file.stat.exists
+
 - name: Generate DH Parameters
   community.crypto.openssl_dhparam:
     path: /etc/ssl/dhparams.pem

roles/traefik/tasks/main.yml

@@ -21,20 +21,6 @@
   loop: "{{ traefik_external }}"
   when: traefik_external is defined
 
-- name: Install Traefik's docker-compose file
-  ansible.builtin.template:
-    src: docker-compose.yml.j2
-    dest: "{{ traefik_root }}/docker-compose.yml"
-    mode: 0400
-  notify: restart_traefik
-
-- name: Install Traefik's docker-compose variables
-  ansible.builtin.template:
-    src: compose-env.j2
-    dest: "{{ traefik_root }}/.env"
-    mode: 0400
-  notify: restart_traefik
-
 - name: Install static Traefik configuration
   ansible.builtin.template:
     src: traefik.yml.j2
@@ -42,8 +28,9 @@
     mode: 0400
   notify: restart_traefik
 
-- name: Start and enable Traefik service
+- name: Start Traefik service and enable on boot
   ansible.builtin.service:
     name: "{{ docker_compose_service }}@{{ traefik_name }}"
     state: started
     enabled: true
+  when: traefik.ENABLED | default('false')