From 665a4ba72ebfbf357050c4affe21195d1d32dc8f Mon Sep 17 00:00:00 2001 From: Kevin Veen-Birkenbach Date: Tue, 21 Mar 2023 11:42:37 +0100 Subject: [PATCH] Updated Documentation --- README.md | 42 ++++++++++++++----- .../docker-akaunting/{readme.md => README.md} | 0 .../{readme.md => README.md} | 0 roles/docker-mailu/{Readme.md => README.md} | 0 .../docker-mastodon/{readme.md => README.md} | 0 .../docker-peertube/{readme.md => README.md} | 0 roles/docker-yourls/{Readme.md => README.md} | 0 .../{readme.md => README.md} | 0 .../{readme.md => README.md} | 0 .../{readme.md => README.md} | 0 roles/native-mailserver/Readme.md | 2 - roles/native-mariadb/handlers/main.yml | 3 -- roles/native-mariadb/tasks/main.yml | 8 ---- .../{readme.md => README.md} | 0 .../{Readme.md => README.md} | 0 15 files changed, 32 insertions(+), 23 deletions(-) rename roles/docker-akaunting/{readme.md => README.md} (100%) rename roles/docker-bigbluebutton/{readme.md => README.md} (100%) rename roles/docker-mailu/{Readme.md => README.md} (100%) rename roles/docker-mastodon/{readme.md => README.md} (100%) rename roles/docker-peertube/{readme.md => README.md} (100%) rename roles/docker-yourls/{Readme.md => README.md} (100%) rename roles/native-apt-update/{readme.md => README.md} (100%) rename roles/native-backups-cleanup/{readme.md => README.md} (100%) rename roles/native-docker-reverse-proxy/{readme.md => README.md} (100%) delete mode 100644 roles/native-mailserver/Readme.md delete mode 100644 roles/native-mariadb/handlers/main.yml delete mode 100644 roles/native-mariadb/tasks/main.yml rename roles/native-primary-backup/{readme.md => README.md} (100%) rename roles/native-pull-primary-backups/{Readme.md => README.md} (100%) diff --git a/README.md b/README.md index 0ec7323a..356edd72 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,41 @@ # Server-Playbook [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0) -## Description -Ansible script to manage servers. +Ansible software to setup and administrate applications and docker images on Linux servers. +With this tool you can setup all of the following application on an root dedicated server in less then 4 hours. -## Roles -The system use the following role namings: +## Included Applications -| role prefix | meaning| -|---|---| -|system-|general system roles which apply basic configurations| -|native-|applications which run native on the system| -|docker-|applications which run on docker containers on the system| +### Docker Applications -## Debug +This software allows to setup the docker following applications: + +- [Nextcloud](./roles/docker-nextcloud/README.md) - Cloud Software +- [Akaunting](./roles/docker-akaunting/README.md) - Business Controlling Software +- [Big Blue Button](./roles/docker-bigbluebutton/README.md) - Video Conference Software +- [Gitea](./roles/docker-gitea/README.md) - Version Controll Software +- [Joomla](./roles/docker-joomla/) - CMS Software +- [Mailu](./roles/docker-mailu/README.md) - Mailsoftware +- [Peertube](./roles/docker-peertube/README.md) - Video Platform Software +- [pixelfed](./roles/docker-pixelfed/README.md) - Photo Platform Software +- [Wordpress](./roles/docker-wordpress/README.md) - Blog Software +- [YOURLS](./roles/docker-yourls/README.md) - URL Shortening Software +- [Mastodon](./roles/docker-mastodon/README.md) - Micro Blog Software +- [Media Wiki](./roles/docker-mediawiki/README.md) - Wiki Software +- [MyBB](./roles/docker-mybb/README.md) - Forum Software + +### Native Applications + +This software shipts the following tools which are natively setup on the server: +- [Backups Cleanup](./roles/native-backups-cleanup/README.md) - Cleans up old backups +- [Btrfs Health Check](./roles/native-btrfs-health-check/README.md) - Checks the health of Btrfs file systems +- [Docker Health Check](./roles/native-docker-health-check/) - Checks the health of docker containers +- [Docker Reverse Proxy](./roles/native-docker-reverse-proxy/README.md) - Docker Reverse Proxy Soltuion +- [Docker Volume Backup](./roles/native-docker-volume-backup/) - Backup Solution for Docker Volumes +- [Pull Primary Backups](./roles/native-pull-primary-backups/README.md) - Pulls the backups from another server and stores them +- [Wireguard](./roles/native-wireguard/README.md) - Integrates the server in an wireguard vpn + +## Server Administration ### Cleanup docker ``bash diff --git a/roles/docker-akaunting/readme.md b/roles/docker-akaunting/README.md similarity index 100% rename from roles/docker-akaunting/readme.md rename to roles/docker-akaunting/README.md diff --git a/roles/docker-bigbluebutton/readme.md b/roles/docker-bigbluebutton/README.md similarity index 100% rename from roles/docker-bigbluebutton/readme.md rename to roles/docker-bigbluebutton/README.md diff --git a/roles/docker-mailu/Readme.md b/roles/docker-mailu/README.md similarity index 100% rename from roles/docker-mailu/Readme.md rename to roles/docker-mailu/README.md diff --git a/roles/docker-mastodon/readme.md b/roles/docker-mastodon/README.md similarity index 100% rename from roles/docker-mastodon/readme.md rename to roles/docker-mastodon/README.md diff --git a/roles/docker-peertube/readme.md b/roles/docker-peertube/README.md similarity index 100% rename from roles/docker-peertube/readme.md rename to roles/docker-peertube/README.md diff --git a/roles/docker-yourls/Readme.md b/roles/docker-yourls/README.md similarity index 100% rename from roles/docker-yourls/Readme.md rename to roles/docker-yourls/README.md diff --git a/roles/native-apt-update/readme.md b/roles/native-apt-update/README.md similarity index 100% rename from roles/native-apt-update/readme.md rename to roles/native-apt-update/README.md diff --git a/roles/native-backups-cleanup/readme.md b/roles/native-backups-cleanup/README.md similarity index 100% rename from roles/native-backups-cleanup/readme.md rename to roles/native-backups-cleanup/README.md diff --git a/roles/native-docker-reverse-proxy/readme.md b/roles/native-docker-reverse-proxy/README.md similarity index 100% rename from roles/native-docker-reverse-proxy/readme.md rename to roles/native-docker-reverse-proxy/README.md diff --git a/roles/native-mailserver/Readme.md b/roles/native-mailserver/Readme.md deleted file mode 100644 index b0c34c6a..00000000 --- a/roles/native-mailserver/Readme.md +++ /dev/null @@ -1,2 +0,0 @@ -# role native-mailserver -This role is not implemented yet. For further information check: https://www.netarky.com/programming/arch_linux/Arch_Linux_mail_server_setup_1.html diff --git a/roles/native-mariadb/handlers/main.yml b/roles/native-mariadb/handlers/main.yml deleted file mode 100644 index 25d7fdb7..00000000 --- a/roles/native-mariadb/handlers/main.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -- name: mariadb restart - service: name=mariadb state=restarted enabled=yes diff --git a/roles/native-mariadb/tasks/main.yml b/roles/native-mariadb/tasks/main.yml deleted file mode 100644 index 8a6b7d15..00000000 --- a/roles/native-mariadb/tasks/main.yml +++ /dev/null @@ -1,8 +0,0 @@ ---- -- name: install MariaDB - pacman: name=mariadb state=present - notify: mariadb restart - -- name: executing installation script - command: mariadb-install-db --user=mysql --basedir=/usr --datadir=/var/lib/mysql - notify: mariadb restart diff --git a/roles/native-primary-backup/readme.md b/roles/native-primary-backup/README.md similarity index 100% rename from roles/native-primary-backup/readme.md rename to roles/native-primary-backup/README.md diff --git a/roles/native-pull-primary-backups/Readme.md b/roles/native-pull-primary-backups/README.md similarity index 100% rename from roles/native-pull-primary-backups/Readme.md rename to roles/native-pull-primary-backups/README.md