From ce82a6101881a4c002099a97350900b33df216e3 Mon Sep 17 00:00:00 2001 From: Kevin Veen-Birkenbach Date: Fri, 14 Mar 2025 14:46:52 +0100 Subject: [PATCH] Small .md optimations --- LICENSE.md | 2 +- roles/docker-central-database/README.md | 2 +- roles/docker-friendica/Administration.md | 34 ++++++++++++------------ 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 3f9161f7..084e0e6f 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,4 @@ -# License Agreement +# License Agreement - CyMaIS NonCommercial License (CNCL) ## Definitions - **"Software":** Refers to *"[CyMaIS - Cyber Master Infrastructure Solution](https://cymais.cloud/)"* and its associated source code. diff --git a/roles/docker-central-database/README.md b/roles/docker-central-database/README.md index 74dc7969..60bea419 100644 --- a/roles/docker-central-database/README.md +++ b/roles/docker-central-database/README.md @@ -4,7 +4,7 @@ This Ansible role provides the necessary tasks, files, templates, and variables --- -## 📌 Overview 🔍 +## 📌 Overview - **Database Variables** Defined in [./vars/database.yml](./vars/database.yml), these variables include: diff --git a/roles/docker-friendica/Administration.md b/roles/docker-friendica/Administration.md index bb432a13..d4526093 100644 --- a/roles/docker-friendica/Administration.md +++ b/roles/docker-friendica/Administration.md @@ -1,6 +1,6 @@ -## Administration 📚 +# Administration -### Full Reset đŸšĢ➡ī¸âœ… +## Full Reset đŸšĢ➡ī¸âœ… The following environment variables need to be defined for successful operation: @@ -14,9 +14,9 @@ rm -rv /mnt/hdd/data/docker/volumes/friendica_data docker volume rm friendica_data ``` -### Reset Database 🗄ī¸ +## Reset Database 🗄ī¸ -#### Manual Method: +## Manual Method: 1. Connect to the MariaDB instance: ```bash docker exec -it central-mariadb mariadb -u root -p @@ -28,63 +28,63 @@ docker volume rm friendica_data exit; ``` -#### Automatic Method: +## Automatic Method: ```bash DB_ROOT_PASSWORD="your_root_password" docker exec -i central-mariadb mariadb -u root -p"${DB_ROOT_PASSWORD}" -e "DROP DATABASE IF EXISTS friendica; CREATE DATABASE friendica;" ``` -### Enter the Application Container 🔍 +## Enter the Application Container 🔍 To access the application container: ```bash docker compose exec -it application sh ``` -### Debugging Tools 🛠ī¸ +## Debugging Tools 🛠ī¸ -#### Check Environment Variables +## Check Environment Variables ```bash docker compose exec -it application printenv ``` -#### Inspect Volume Data +## Inspect Volume Data ```bash ls -la /var/lib/docker/volumes/friendica_data/_data/ ``` -### Autoinstall 🌟 +## Autoinstall 🌟 Run the following command to autoinstall Friendica: ```bash docker compose exec --user www-data -it application bin/console autoinstall ``` -### Reinitialization 🔄 +## Reinitialization 🔄 -#### Docker Only: +## Docker Only: ```bash docker-compose up -d --force-recreate ``` -#### Full Reinitialization: +## Full Reinitialization: ```bash docker-compose up -d --force-recreate && sleep 2; docker compose exec --user www-data -it application bin/console autoinstall; ``` -### Configuration Information ℹī¸ +## Configuration Information ℹī¸ -#### General Configuration: +## General Configuration: ```bash cat /var/lib/docker/volumes/friendica_data/_data/config/local.config.php ``` -#### Email Configuration: +## Email Configuration: ```bash docker compose exec -it application cat /etc/msmtprc ``` -### Email Debugging ✉ī¸ +## Email Debugging ✉ī¸ To send a test email: ```bash