Refactored docker role

playbook.yml

@@ -329,7 +329,7 @@
   hosts: docker
   become: true
   roles:
-    - application-docker
+    - pc-docker
 
 
 - name: setup backup to swappable

roles/docker-akaunting/README.md

@@ -1,41 +1,63 @@
-# docker akaunting
+# Docker Akaunting Setup Guide
 
-## new setup
+## Introduction
-```bash
+This guide details the process of setting up Akaunting, a free and online accounting software, using Docker. It's tailored to help you deploy and manage an Akaunting instance efficiently using Docker and Docker Compose.
-cd {{path_docker_compose_files}}akaunting/
-export COMPOSE_HTTP_TIMEOUT=600
-export DOCKER_CLIENT_TIMEOUT=600
-AKAUNTING_SETUP=true docker-compose -p akaunting up -d
-```
 
-Check Webinterface and then execute: 
+## Better Alternatives to Akaunting
 
-```bash
+Due to license issues, bugs and that in the past after an akaunting update your functions get reduced, I recommend the use of other finance software.
-docker-compose down
+[GNUCASH](https://www.gnucash.org/) offers more functions for SMB's, allows tracking of bank and trading accounts and in combination with Nextcloud it's a very good tool for smal companies to manage there finances.
-docker-compose -p akaunting up -d
-```
 
-## administration
+## Prerequisites
+- Docker and Docker Compose installed.
+- Basic understanding of Docker concepts.
+- Access to the command line or terminal.
 
-### get logs
+## Installation Steps
 
-```bash
+### New Manual Setup
-docker-compose exec -it akaunting tail -n 300 storage/logs/laravel.log 
+1. **Navigate to Docker Compose Directory**: Change to the directory containing your Docker Compose files for Akaunting.
-```
 
-### enter akaunting container
+    ```bash
+    cd {{path_docker_compose_files}}akaunting/
+    ```
 
-```bash
+2. **Set Environment Variables**: These are necessary to prevent timeouts during long operations.
-docker-compose exec -it akaunting bash
-```
 
-### enter database container
+    ```bash
+    export COMPOSE_HTTP_TIMEOUT=600
+    export DOCKER_CLIENT_TIMEOUT=600
+    ```
 
-```bash
+3. **Start Akaunting Service**: This command will initialize the Akaunting setup.
-docker-compose exec -it akaunting-db /bin/mysql -u admin --password=$akaunting_db_password akaunting
+
-```
+    ```bash
+    AKAUNTING_SETUP=true docker-compose -p akaunting up -d
+    ```
+
+4. **Check Web Interface**: Ensure the web interface is operational.
+
+5. **Restart Services**: To finalize the setup, restart the services.
+
+    ```bash
+    docker-compose down
+    docker-compose -p akaunting up -d
+    ```
+
+### Administration
+- **View Logs**: To check the latest logs of Akaunting.
+
+    ```bash
+    docker-compose exec -it akaunting tail -n 300 storage/logs/laravel.log 
+    ```
+
+- **Access Containers**: For troubleshooting or configuration.
+  - Akaunting Container: `docker-compose exec -it akaunting bash`
+  - Database Container: `docker-compose exec -it akaunting-db /bin/mariadb -u admin --password=$akaunting_db_password akaunting`
+
+### Manual Update
+Execute PHP artisan commands in the following order for updating Akaunting:
 
-## manuel update
 ```bash
 php artisan about
 php artisan cache:clear
@@ -45,55 +67,39 @@ php artisan update:all
 php artisan update:db
 ```
 
-## composer
+### Composer
-```bash
+To install Composer, a PHP dependency management tool:
-curl https://getcomposer.org/download/2.4.1/composer.phar --output composer.phar
-```
 
 ```bash
+curl https://getcomposer.org/download/2.4.1/composer.phar --output composer.phar
 php composer.phar install
 ```
 
-## full backup routine
+### Full Backup Routine
+Detailed steps for backing up your Akaunting instance, including setting manual and automatic variables, destroying containers, removing volumes, and rebuilding and recovering volumes. (Refer to the full backup routine script in the original README).
 
-```bash
+### Setting Variables
-# DO SET MANUEL VARIABLES >>
+Variables are crucial in configuring your Akaunting setup. Ensure you set the following variables correctly in your environment:
-export akaunting_db_password=XXXXXXXXX
-export backup_version=XXXXXXXXX
-# << DO SET MANUEL VARIABLES
 
-# set automatic variables
+- `docker_compose_akaunting_path`: Set this variable to the path where your Docker Compose files for Akaunting are located.
-export machine_id="$(sha256sum /etc/machine-id)"
+- `akaunting_db_password`, `akaunting_version`, `akaunting_company_name`, `akaunting_company_email`, `akaunting_setup_admin_email`, and `akaunting_setup_admin_password`: These should be set in your `.env` files as per your requirements.
-export COMPOSE_HTTP_TIMEOUT=600
-export DOCKER_CLIENT_TIMEOUT=600
 
-# destroy all containers
+### Additional Configuration
-cd {{path_docker_compose_files}}akaunting/ && 
+- **SSL Certificate**: The guide includes steps to receive a certificate for your domain.
-docker-compose down &&
+- **Nginx Configuration**: Necessary steps to configure Nginx as a reverse proxy for Akaunting.
-docker network prune -f
+- **Database and Runtime Environment**: Instructions on how to set up the `db.env` and `run.env` files for database and runtime configurations.
 
-# delete all volumes
+## Further Information
-docker volume rm akaunting_akaunting-data akaunting_akaunting-db akaunting_akaunting-modules
+For more details, visit the [Akaunting Docker Repository](https://github.com/akaunting/docker) and the [Akaunting Forums](https://akaunting.com/forum).
 
-# rebuild containers
+## Contribution and Feedback
-docker-compose pull &&
-docker-compose build &&
-docker-compose -p akaunting up -d --force-recreate
 
-# recover all volumes
+Your contributions and feedback are welcome. Please reach out for support or queries at kevin@veen.world.
-cd {{path_administrator_scripts}}backup-docker-to-local &&
-bash recover-docker-from-local.sh akaunting_akaunting-modules ${machine_id:0:64} "$backup_version" &&
-bash recover-docker-from-local.sh akaunting_akaunting-data ${machine_id:0:64} "$backup_version" &&
-bash recover-docker-from-local.sh akaunting_akaunting-db ${machine_id:0:64} "$backup_version" akaunting-db "$akaunting_db_password" akaunting
 
-```
+## License
 
-## todo 
+This project is licensed under the GNU Affero General Public License v3.0.
-- implement build when new akaunting version is set
 
-## Further information
+## Author
-- https://github.com/akaunting/docker
+
-- https://akaunting.com/forum/discussion/installation-update/updating-to-300-failed-cant-manually-update-either
+This script is developed by Kevin Veen-Birkenbach. You can reach out to him at kevin@veen.world or visit his website at https://www.veen.world.
-- https://akaunting.com/forum/discussion/installation-update/not-able-to-update-core
-- https://akaunting.com/forum/discussion/installation-update/update-to-203-not-able-to-finalize-core-installation
-- https://akaunting.com/forum/discussion/installation-update/how-to-perform-manual-update-v2116

roles/pc-docker/README.md

@@ -0,0 +1,32 @@
+# README for PC-Docker Playbook
+
+## Overview
+This playbook, `pc-docker`, is part of a larger collection housed within the `computer-playbook` repository. It is specifically tailored for setting up Docker and Docker Compose on personal computers (PCs) used for development purposes. The primary goal is to facilitate a development environment on individual workstations rather than configuring servers for hosting or distributing Docker images.
+
+## Contents
+The `main.yml` file in the `pc-docker` role consists of two primary tasks:
+
+1. **Install Docker**: This task uses the `community.general.pacman` module to install `docker` and `docker-compose` on the system. It ensures that these packages are present on the PC.
+
+2. **User Group Configuration**: This task adds a specified user (denoted as `{{client_username}}`) to the Docker user group. This is crucial for allowing the specified user to interact with Docker without needing superuser permissions.
+
+## Use Case
+The playbook is designed for developers who require Docker in their local development environments. It simplifies the process of Docker installation and configuration, making it straightforward for developers to start containerizing their applications without the complexities often encountered in a server or production environment.
+
+## Prerequisites
+- Ansible: Ensure that Ansible is installed on your system to run this playbook.
+- Arch Linux-based System: This playbook uses the `pacman` package manager, indicating it's designed for Arch Linux-based systems.
+
+## Running the Playbook
+To run this playbook:
+1. Clone the `computer-playbook` repository.
+2. Navigate to the `roles/pc-docker` directory.
+3. Run the playbook using the appropriate Ansible commands, ensuring that you have the necessary privileges.
+
+## Important Notes
+- **Not for Server Use**: This playbook is not designed for server environments. It is optimized for individual development machines.
+- **Customization**: You may need to customize the playbook, especially the `{{client_username}}` variable, to suit your specific setup.
+- **Security Considerations**: While adding a user to the Docker group provides ease of use, be aware of the security implications. It grants the user elevated privileges which, if misused, can affect the entire system.
+
+## Support & Contribution
+For support, suggestions, or contributions, please raise an issue or a pull request in the `computer-playbook` repository. This project welcomes contributions from the developer community.

roles/pc-docker/tasks/main.yml

@@ -5,7 +5,7 @@
       - docker-compose
     state: present
 
-- name: Adding user {{client_username}} to relevant arduino usergroups  
+- name: Adding user {{client_username}} to relevant docker usergroup  
   user: name={{client_username}}
         groups=docker
         append=yes