kevinveenbirkenbach/computer-playbook
1
0
Fork 0
mirror of https://github.com/kevinveenbirkenbach/computer-playbook.git synced 2024-11-26 06:31:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated akaunting

Browse Source
This commit is contained in:
Kevin Veen-Birkenbach 2023-12-02 14:27:36 +01:00
parent 63cacea9e7
commit a850187bf0
1 changed files with 71 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

116
roles/docker-akaunting/README.md
View File

@ -1,41 +1,63 @@
# docker akaunting # Docker Akaunting Setup Guide
## Introduction
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.
## Better Alternatives to Akaunting
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.
[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.
## Prerequisites
- Docker and Docker Compose installed.
- Basic understanding of Docker concepts.
- Access to the command line or terminal.
## Installation Steps
### New Manual Setup
1. **Navigate to Docker Compose Directory**: Change to the directory containing your Docker Compose files for Akaunting.
## new setup
```bash ```bash
cd {{path_docker_compose_files}}akaunting/ cd {{path_docker_compose_files}}akaunting/
```
2. **Set Environment Variables**: These are necessary to prevent timeouts during long operations.
```bash
export COMPOSE_HTTP_TIMEOUT=600 export COMPOSE_HTTP_TIMEOUT=600
export DOCKER_CLIENT_TIMEOUT=600 export DOCKER_CLIENT_TIMEOUT=600
```
3. **Start Akaunting Service**: This command will initialize the Akaunting setup.
```bash
AKAUNTING_SETUP=true docker-compose -p akaunting up -d AKAUNTING_SETUP=true docker-compose -p akaunting up -d
``` ```
Check Webinterface and then execute: 4. **Check Web Interface**: Ensure the web interface is operational.
5. **Restart Services**: To finalize the setup, restart the services.
```bash ```bash
docker-compose down docker-compose down
docker-compose -p akaunting up -d docker-compose -p akaunting up -d
``` ```
## administration ### Administration
- **View Logs**: To check the latest logs of Akaunting.
### get logs
```bash ```bash
docker-compose exec -it akaunting tail -n 300 storage/logs/laravel.log docker-compose exec -it akaunting tail -n 300 storage/logs/laravel.log
``` ```
### enter akaunting container - **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`
```bash ### Manual Update
docker-compose exec -it akaunting bash Execute PHP artisan commands in the following order for updating Akaunting:
```
### enter database container
```bash
docker-compose exec -it akaunting-db /bin/mariadb -u admin --password=$akaunting_db_password akaunting
```
## manuel update
```bash ```bash
php artisan about php artisan about
php artisan cache:clear php artisan cache:clear
@ -45,55 +67,39 @@ php artisan update:all
php artisan update:db 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 ```bash
curl https://getcomposer.org/download/2.4.1/composer.phar --output composer.phar
php composer.phar install 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