mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-08-29 15:06:26 +02:00
Optimized .mds and meta/main.yml for client-wireguard roles and refactored README.md of Docker Roles
This commit is contained in:
31
roles/docker-akaunting/Administration.md
Normal file
31
roles/docker-akaunting/Administration.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# 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
|
||||
- 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:
|
||||
|
||||
```bash
|
||||
php artisan about
|
||||
php artisan cache:clear
|
||||
php artisan view:clear
|
||||
php artisan migrate:status
|
||||
php artisan update:all
|
||||
php artisan update:db
|
||||
```
|
||||
|
||||
## Composer
|
||||
To install Composer, a PHP dependency management tool:
|
||||
|
||||
```bash
|
||||
curl https://getcomposer.org/download/2.4.1/composer.phar --output composer.phar
|
||||
php composer.phar install
|
||||
```
|
32
roles/docker-akaunting/INSTALLATIONN.md
Normal file
32
roles/docker-akaunting/INSTALLATIONN.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Installation Steps
|
||||
|
||||
@ATTENTION Variable ```#AKAUNTING_SETUP: true``` needs to be set
|
||||
|
||||
## New Manual Setup
|
||||
1. **Navigate to Docker Compose Directory**: Change to the directory containing your Docker Compose files for Akaunting.
|
||||
|
||||
```bash
|
||||
cd {{path_docker_compose_instances}}akaunting/
|
||||
```
|
||||
|
||||
2. **Set Environment Variables**: These are necessary to prevent timeouts during long operations.
|
||||
|
||||
```bash
|
||||
export COMPOSE_HTTP_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
|
||||
```
|
||||
|
||||
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
|
||||
```
|
@@ -16,69 +16,6 @@ This guide details the process of setting up Akaunting, a free and online accoun
|
||||
- Basic understanding of Docker concepts.
|
||||
- Access to the command line or terminal.
|
||||
|
||||
## Installation Steps
|
||||
|
||||
@ATTENTION Variable ```#AKAUNTING_SETUP: true``` needs to be set
|
||||
|
||||
### New Manual Setup
|
||||
1. **Navigate to Docker Compose Directory**: Change to the directory containing your Docker Compose files for Akaunting.
|
||||
|
||||
```bash
|
||||
cd {{path_docker_compose_instances}}akaunting/
|
||||
```
|
||||
|
||||
2. **Set Environment Variables**: These are necessary to prevent timeouts during long operations.
|
||||
|
||||
```bash
|
||||
export COMPOSE_HTTP_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
|
||||
```
|
||||
|
||||
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:
|
||||
|
||||
```bash
|
||||
php artisan about
|
||||
php artisan cache:clear
|
||||
php artisan view:clear
|
||||
php artisan migrate:status
|
||||
php artisan update:all
|
||||
php artisan update:db
|
||||
```
|
||||
|
||||
### Composer
|
||||
To install Composer, a PHP dependency management tool:
|
||||
|
||||
```bash
|
||||
curl https://getcomposer.org/download/2.4.1/composer.phar --output composer.phar
|
||||
php composer.phar install
|
||||
```
|
||||
|
||||
### 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).
|
||||
@@ -94,7 +31,7 @@ Variables are crucial in configuring your Akaunting setup. Ensure you set the fo
|
||||
- **Nginx Configuration**: Necessary steps to configure Nginx as a reverse proxy for Akaunting.
|
||||
- **Database and Runtime Environment**: Instructions on how to set up the `db.env` and `run.env` files for database and runtime configurations.
|
||||
|
||||
## Further Information
|
||||
## 📚 Other Resources
|
||||
For more details, visit the [Akaunting Docker Repository](https://github.com/akaunting/docker) and the [Akaunting Forums](https://akaunting.com/forum).
|
||||
|
||||
## Contribution and Feedback
|
||||
|
Reference in New Issue
Block a user