From efad73415d29d443a43981775b8a454a5c95120e Mon Sep 17 00:00:00 2001 From: Kevin Veen-Birkenbach Date: Mon, 17 Mar 2025 13:21:05 +0100 Subject: [PATCH] Replaced Other Resources without icon --- roles/backup-remote-to-local/README.md | 2 +- roles/backups-provider-user/README.md | 2 +- roles/cleanup-backups-service/README.md | 2 +- roles/client-wireguard-behind-firewall/README.md | 2 +- roles/client-wireguard/README.md | 2 +- roles/docker-akaunting/README.md | 2 +- roles/docker-baserow/README.md | 2 +- roles/docker-bigbluebutton/README.md | 2 +- roles/docker-bluesky/README.md | 2 +- roles/docker-friendica/README.md | 2 +- roles/docker-funkwhale/README.md | 2 +- roles/docker-gitea/README.md | 2 +- roles/docker-gitlab/README.md | 2 +- roles/docker-keycloak/README.md | 2 +- roles/docker-listmonk/README.md | 2 +- roles/docker-mastodon/README.md | 2 +- roles/docker-mediawiki/README.md | 2 +- roles/docker-moodle/README.md | 2 +- roles/docker-mybb/README.md | 2 +- roles/docker-nextcloud/README.md | 2 +- roles/docker-peertube/README.md | 2 +- roles/docker-roulette-wheel/README.md | 2 +- roles/driver-epson-multiprinter/README.md | 2 +- roles/pc-administrator-tools/README.md | 2 +- roles/pc-bluray-player-tools/README.md | 2 +- roles/pc-gnome/README.md | 2 +- roles/pc-jrnl/README.md | 2 +- roles/pc-video-conference/README.md | 2 +- roles/sshd/README.md | 2 +- roles/system-aur-helper/README.md | 2 +- roles/systemd-notifier-email/README.md | 2 +- roles/systemd-notifier-telegram/README.md | 2 +- roles/wireguard/Administration.md | 2 +- 33 files changed, 33 insertions(+), 33 deletions(-) diff --git a/roles/backup-remote-to-local/README.md b/roles/backup-remote-to-local/README.md index c57e49b7..47bfe23f 100644 --- a/roles/backup-remote-to-local/README.md +++ b/roles/backup-remote-to-local/README.md @@ -20,7 +20,7 @@ Backup Remote to Local is a robust solution for retrieving backup data from remo - **Integration with Other Roles:** Works alongside roles like backup-directory-validator, cleanup-failed-docker-backups, systemd-timer, backups-provider, and system-maintenance-lock. - **Administrative Debugging:** Detailed debug instructions and administrative tasks are provided in a separate file. -## 📚 Other Resources +## Other Resources - **Backup Scheme:** ![backup scheme](https://www.veen.world/wp-content/uploads/2020/12/server-backup-768x567.jpg) diff --git a/roles/backups-provider-user/README.md b/roles/backups-provider-user/README.md index 328dc655..df16fabe 100644 --- a/roles/backups-provider-user/README.md +++ b/roles/backups-provider-user/README.md @@ -20,7 +20,7 @@ The purpose of this role is to enhance the security of your backup system by pro - **Sudo Configuration:** Grants passwordless sudo rights for rsync, enabling secure and automated backup transfers. - **Integration:** Supports seamless integration with your backup infrastructure by limiting the backup user's permissions to only the required commands. -## 📚 Other Resources +## Other Resources For more details on how the role works and advanced configuration options, please see the related references below: - [Ansible Playbooks Lookups](https://docs.ansible.com/ansible/latest/user_guide/playbooks_lookups.html#id3) diff --git a/roles/cleanup-backups-service/README.md b/roles/cleanup-backups-service/README.md index 130c24be..d7eb729f 100644 --- a/roles/cleanup-backups-service/README.md +++ b/roles/cleanup-backups-service/README.md @@ -23,5 +23,5 @@ The primary purpose of this role is to maintain optimal backup storage by automa - **Systemd Integration:** Configures a systemd service to run cleanup tasks. - **Dependency Integration:** Works in conjunction with related roles for comprehensive backup management. -## 📚 Other Resources +## Other Resources - https://stackoverflow.com/questions/48929553/get-hard-disk-size-in-python \ No newline at end of file diff --git a/roles/client-wireguard-behind-firewall/README.md b/roles/client-wireguard-behind-firewall/README.md index dbbd582a..04c08cb9 100644 --- a/roles/client-wireguard-behind-firewall/README.md +++ b/roles/client-wireguard-behind-firewall/README.md @@ -21,6 +21,6 @@ The primary purpose of this role is to enable proper routing and connectivity fo - **NAT Support:** Configures the external interface for proper masquerading. - **Role Integration:** Depends on the [client-wireguard](../client-wireguard/README.md) role to ensure that WireGuard is properly configured before applying firewall rules. -## 📚 Other Resources +## Other Resources - https://gist.github.com/insdavm/b1034635ab23b8839bf957aa406b5e39 - https://wiki.debian.org/iptables diff --git a/roles/client-wireguard/README.md b/roles/client-wireguard/README.md index b3355f77..0a46bf80 100644 --- a/roles/client-wireguard/README.md +++ b/roles/client-wireguard/README.md @@ -22,7 +22,7 @@ The primary purpose of this role is to configure WireGuard on a client by settin - **Administration Support:** For client key creation and further setup, please refer to the [Administration](./Administration.md) file. - **Modular Design:** Easily integrates with other WireGuard roles or network configuration roles. -## 📚 Other Resources +## Other Resources - [WireGuard Documentation](https://www.wireguard.com/) - [ArchWiki: WireGuard](https://wiki.archlinux.org/index.php/WireGuard) diff --git a/roles/docker-akaunting/README.md b/roles/docker-akaunting/README.md index cd06bcfa..e016d0b7 100644 --- a/roles/docker-akaunting/README.md +++ b/roles/docker-akaunting/README.md @@ -31,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. -## 📚 Other Resources +## 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 diff --git a/roles/docker-baserow/README.md b/roles/docker-baserow/README.md index 8d6c1f8b..9ae8339c 100644 --- a/roles/docker-baserow/README.md +++ b/roles/docker-baserow/README.md @@ -2,7 +2,7 @@ This role allows the setup of [baserole](https://baserow.io/). -## 📚 Other Resources +## Other Resources It was created with the help of [Chat GPT-4](https://chat.openai.com/share/556c2d7f-6b6f-4256-a646-a50529554efc). diff --git a/roles/docker-bigbluebutton/README.md b/roles/docker-bigbluebutton/README.md index 5a346579..87a8cce9 100644 --- a/roles/docker-bigbluebutton/README.md +++ b/roles/docker-bigbluebutton/README.md @@ -6,7 +6,7 @@ Role to deploy [BigBlueButton](https://bigbluebutton.org/). ## SSO - https://docs.bigbluebutton.org/greenlight/v3/external-authentication/ -## 📚 Other Resources +## Other Resources - https://github.com/bigbluebutton/docker - https://docs.bigbluebutton.org/greenlight/gl-install.html#setting-bigbluebutton-credentials - https://goneuland.de/big-blue-button-mit-docker-und-traefik-installieren/ diff --git a/roles/docker-bluesky/README.md b/roles/docker-bluesky/README.md index ab5efac4..066094df 100644 --- a/roles/docker-bluesky/README.md +++ b/roles/docker-bluesky/README.md @@ -1,7 +1,7 @@ # DRAFT role docker-bluesky -## 📚 Other Resources +## Other Resources - https://therobbiedavis.com/selfhosting-bluesky-with-docker-and-swag/ - Relevant for proxy configuration: https://cprimozic.net/notes/posts/notes-on-self-hosting-bluesky-pds-alongside-other-services/ - https://github.com/bluesky-social/pds diff --git a/roles/docker-friendica/README.md b/roles/docker-friendica/README.md index 43df8b7d..de51d2c2 100644 --- a/roles/docker-friendica/README.md +++ b/roles/docker-friendica/README.md @@ -13,7 +13,7 @@ Ensure you have the following: - A central MariaDB instance running - Necessary permissions to manage Docker and database configurations -## 📚 Other Resources +## Other Resources - [Friendica Docker Hub](https://hub.docker.com/_/friendica) - [Friendica Installation Docs](https://wiki.friendi.ca/docs/install) diff --git a/roles/docker-funkwhale/README.md b/roles/docker-funkwhale/README.md index f9eaa90c..3cb05893 100644 --- a/roles/docker-funkwhale/README.md +++ b/roles/docker-funkwhale/README.md @@ -2,5 +2,5 @@ This role doesn't work and needs to be implemented -## 📚 Other Resources +## Other Resources - https://docs.funkwhale.audio/installation/docker.html \ No newline at end of file diff --git a/roles/docker-gitea/README.md b/roles/docker-gitea/README.md index 3e2f204b..8bc66bf0 100644 --- a/roles/docker-gitea/README.md +++ b/roles/docker-gitea/README.md @@ -1,5 +1,5 @@ # role docker-gitea -## 📚 Other Resources +## Other Resources - [Gitea LDAP integration](https://docs.gitea.com/usage/authentication) - [Gitea Alternatives](https://chatgpt.com/share/67a5f599-c9b0-800f-87fe-49a3b61263e6) \ No newline at end of file diff --git a/roles/docker-gitlab/README.md b/roles/docker-gitlab/README.md index 8e8c515c..97694967 100644 --- a/roles/docker-gitlab/README.md +++ b/roles/docker-gitlab/README.md @@ -33,7 +33,7 @@ Include this role in your Ansible playbooks and specify the necessary variables. For a detailed walkthrough and explanation of this role, refer to the conversation at [ChatGPT Session Transcript](https://chat.openai.com/share/1b0147bf-d4de-4790-b8ed-c332aa4e3ce3). -## 📚 Other Resources +## Other Resources - https://ralph.blog.imixs.com/2019/06/09/running-gitlab-on-docker/ ## Performance Optimation diff --git a/roles/docker-keycloak/README.md b/roles/docker-keycloak/README.md index b112dca7..55e66bac 100644 --- a/roles/docker-keycloak/README.md +++ b/roles/docker-keycloak/README.md @@ -13,7 +13,7 @@ The role integrates Keycloak with PostgreSQL as a database and supports operatio - Support for running behind a reverse proxy (e.g., NGINX). - Automatic creation and management of Docker Compose files. -## 📚 Other Resources 📚 +## Other Resources 📚 For more details about Keycloak, check out: - [Official Keycloak Documentation](https://www.keycloak.org/) diff --git a/roles/docker-listmonk/README.md b/roles/docker-listmonk/README.md index 610a457e..d82cbba3 100644 --- a/roles/docker-listmonk/README.md +++ b/roles/docker-listmonk/README.md @@ -11,7 +11,7 @@ This role deploys the Listmonk application using Docker. Listmonk is a high perf - **docker-compose.yml**: Defines the Docker setup for Listmonk and its database. - **config.toml**: Contains the application settings including the database connection, admin credentials, and server settings. -## 📚 Other Resources +## Other Resources - For detailed installation instructions and configuration options, visit the [Listmonk Installation Documentation](https://listmonk.app/docs/installation/). - You can also find more information on the [Listmonk GitHub Repository](https://github.com/knadh/listmonk/). diff --git a/roles/docker-mastodon/README.md b/roles/docker-mastodon/README.md index dcadbc8e..d5e9af8f 100644 --- a/roles/docker-mastodon/README.md +++ b/roles/docker-mastodon/README.md @@ -7,7 +7,7 @@ This project provides a **Docker-based setup for Mastodon**, including full **OI This README and some parts of the code were created with the assistance of ChatGPT. You can follow the discussion and evolution of this project in [this conversation](https://chatgpt.com/c/67a4e19b-3884-800f-9d45-621dda2a6572). -## 📚 Other Resources +## Other Resources - [Mastodon with Docker & Traefik](https://goneuland.de/mastodon-mit-docker-und-traefik-installieren/) - [Mastodon Configuration Guide](https://gist.github.com/TrillCyborg/84939cd4013ace9960031b803a0590c4) - [Check Website Availability](https://www.2daygeek.com/linux-command-check-website-is-up-down-alive/) diff --git a/roles/docker-mediawiki/README.md b/roles/docker-mediawiki/README.md index 35f2b3ea..f9697a24 100644 --- a/roles/docker-mediawiki/README.md +++ b/roles/docker-mediawiki/README.md @@ -1,4 +1,4 @@ # role docker-mediawiki -## 📚 Other Resources +## Other Resources This role was adapted to solve some deprecation message. Please test it before using productive. [See this conversation](https://chatgpt.com/share/6781487e-45fc-800f-a35e-e93f49448176). diff --git a/roles/docker-moodle/README.md b/roles/docker-moodle/README.md index 94922b4d..a66f76d4 100644 --- a/roles/docker-moodle/README.md +++ b/roles/docker-moodle/README.md @@ -1,4 +1,4 @@ # role docker-moodle -## 📚 Other Resources +## Other Resources - https://github.com/bitnami/containers/tree/main/bitnami/moodle \ No newline at end of file diff --git a/roles/docker-mybb/README.md b/roles/docker-mybb/README.md index 73eeb631..e1125e9c 100644 --- a/roles/docker-mybb/README.md +++ b/roles/docker-mybb/README.md @@ -3,5 +3,5 @@ ## Credits 📝 This README was created with the assistance of ChatGPT, based on a conversation held at this [link](https://chat.openai.com/share/83828f9a-b817-48d8-86ed-599f64850b4d). ChatGPT provided guidance on structuring this document and outlining the key components of the Docker MyBB role. -## 📚 Other Resources +## Other Resources - https://github.com/mybb/docker \ No newline at end of file diff --git a/roles/docker-nextcloud/README.md b/roles/docker-nextcloud/README.md index 5a088010..facc5f53 100644 --- a/roles/docker-nextcloud/README.md +++ b/roles/docker-nextcloud/README.md @@ -3,7 +3,7 @@ This repository contains an Ansible role for deploying and managing [Nextcloud](https://nextcloud.com/) using [Docker](https://www.docker.com/). It covers configuration modifications, updates, backups, database management, and more. Additionally, OIDC (OpenID Connect) is supported (for example, via **Keycloak**). --- -## 📚 Other Resources +## Other Resources - [Nextcloud Docker Example with Nginx Proxy, MariaDB, and FPM](https://github.com/nextcloud/docker/blob/master/.examples/docker-compose/with-nginx-proxy/mariadb/fpm/docker-compose.yml) - [Nextcloud Upgrade via Docker by Goneuland](https://goneuland.de/nextcloud-upgrade-auf-neue-versionen-mittels-docker/) diff --git a/roles/docker-peertube/README.md b/roles/docker-peertube/README.md index 54a58103..4b647db3 100644 --- a/roles/docker-peertube/README.md +++ b/roles/docker-peertube/README.md @@ -1,7 +1,7 @@ # docker peertube -## 📚 Other Resources +## Other Resources - https://docs.joinpeertube.org/install-docker - https://github.com/Chocobozzz/PeerTube/issues/3091 - [OIDC Plugin installation](https://chatgpt.com/c/67a4f448-4be8-800f-8639-4c15cb2fb44e) \ No newline at end of file diff --git a/roles/docker-roulette-wheel/README.md b/roles/docker-roulette-wheel/README.md index 375d0ddc..a51b80fe 100644 --- a/roles/docker-roulette-wheel/README.md +++ b/roles/docker-roulette-wheel/README.md @@ -1,6 +1,6 @@ # docker roulette-wheel -## 📚 Other Resources +## Other Resources - https://github.com/p-wojt/roulette-wheel - https://dev.to/ms314006/how-to-package-front-end-projects-into-docker-images-and-use-it-with-webpack-go3 - https://stackoverflow.com/questions/53178820/dockerfile-to-run-nodejs-static-content-in-docker-container diff --git a/roles/driver-epson-multiprinter/README.md b/roles/driver-epson-multiprinter/README.md index 6ca1c5b8..7b4633e2 100644 --- a/roles/driver-epson-multiprinter/README.md +++ b/roles/driver-epson-multiprinter/README.md @@ -1,5 +1,5 @@ # role driver-epson-multiprinter -## 📚 Other Resources +## Other Resources - https://bernhardsteindl.at/epson-ecotank-et-3600-unter-arch-linux-einrichten/ - http://download.ebz.epson.net/dsc/search/01/search/searchModule - https://aur.archlinux.org/packages/epson-inkjet-printer-escpr diff --git a/roles/pc-administrator-tools/README.md b/roles/pc-administrator-tools/README.md index 099bf022..3abff310 100644 --- a/roles/pc-administrator-tools/README.md +++ b/roles/pc-administrator-tools/README.md @@ -12,7 +12,7 @@ The `main.yml` file in this role consists of tasks that automate the installatio There are commented-out tasks for installing additional AUR packages, such as `aacskeys` and `libbdplus`, which can be enabled as per the user's requirements. -## 📚 Other Resources and Resources +## Other Resources and Resources For more in-depth information and guidance on Blu-ray playback and software configuration, the following resources can be consulted: - [Arch Linux Wiki on Blu-ray](https://wiki.archlinux.org/title/Blu-ray#Using_aacskeys) - [Guide to Play Blu-ray with VLC](https://videobyte.de/play-blu-ray-with-vlc) diff --git a/roles/pc-bluray-player-tools/README.md b/roles/pc-bluray-player-tools/README.md index 16e07f9f..61516b11 100644 --- a/roles/pc-bluray-player-tools/README.md +++ b/roles/pc-bluray-player-tools/README.md @@ -1,6 +1,6 @@ # collection-blu-ray-player -## 📚 Other Resources +## Other Resources - https://wiki.archlinux.org/title/Blu-ray#Using_aacskeys - https://videobyte.de/play-blu-ray-with-vlc - https://archived.forum.manjaro.org/t/wie-kann-ich-bluray-uhd-abspielen/127396/12 diff --git a/roles/pc-gnome/README.md b/roles/pc-gnome/README.md index 652b2a5e..760c895b 100644 --- a/roles/pc-gnome/README.md +++ b/roles/pc-gnome/README.md @@ -24,7 +24,7 @@ The `pc-gnome` role includes several tasks for installing GNOME software, managi 6. **Execute CLI GNOME Extension Manager Script**: - Runs the CLI GNOME Extension Manager script to manage GNOME extensions based on the `{{gnome_extensions}}` variable. -## 📚 Other Resources +## Other Resources For additional details on managing GNOME extensions via command line, visit [Ask Ubuntu](https://askubuntu.com/questions/1029376/how-do-i-enable-and-disable-gnome-extensions-from-the-command-line). ## Dependencies diff --git a/roles/pc-jrnl/README.md b/roles/pc-jrnl/README.md index 14dfc6fb..46270527 100644 --- a/roles/pc-jrnl/README.md +++ b/roles/pc-jrnl/README.md @@ -28,6 +28,6 @@ For more detailed information on Jrnl and its functionalities, visit [Jrnl's off ## Contributing Contributions to this role are welcome. Please adhere to standard coding conventions and best practices. -## 📚 Other Resources +## Other Resources This role was created as part of a larger playbook. For more context on this role, you can refer to the related ChatGPT conversation [here](https://chat.openai.com/share/ae168ca0-5191-4bec-96a0-ffcfabca0024). \ No newline at end of file diff --git a/roles/pc-video-conference/README.md b/roles/pc-video-conference/README.md index 3d0d22a9..f5658228 100644 --- a/roles/pc-video-conference/README.md +++ b/roles/pc-video-conference/README.md @@ -9,7 +9,7 @@ The `main.yml` file in the `pc-video-conference` role includes tasks for setting 1. **Install Video Conference Software**: - Utilizes the `kewlfft.aur.aur` module with `yay` as the helper to install `zoom`, a popular video conferencing application. -## 📚 Other Resources +## Other Resources - As noted, the Microsoft Teams client is no longer natively supported on Linux. For more information and potential workarounds, you can visit the [AUR package page for Teams](https://aur.archlinux.org/packages/teams). ## Dependencies diff --git a/roles/sshd/README.md b/roles/sshd/README.md index 98f46e7e..2a0313a6 100644 --- a/roles/sshd/README.md +++ b/roles/sshd/README.md @@ -21,6 +21,6 @@ The primary purpose of this role is to establish a secure SSH environment by dep - **Systemd Integration:** Automatically restarts the SSH service upon configuration changes. - **Security Enhancements:** Enforces secure defaults such as disabled root login and public key authentication. -## 📚 Other Resources +## Other Resources - https://www.google.com/search?client=firefox-b-d&q=sshd+why+to+deactivate+pam - https://man7.org/linux/man-pages/man5/sshd_config.5.html diff --git a/roles/system-aur-helper/README.md b/roles/system-aur-helper/README.md index da0d6387..6405a164 100644 --- a/roles/system-aur-helper/README.md +++ b/roles/system-aur-helper/README.md @@ -20,5 +20,5 @@ The primary purpose of this role is to streamline AUR package management on Arch - **User Creation:** Creates a dedicated `aur_builder` user. - **Sudo Configuration:** Grants passwordless sudo rights to `aur_builder` for pacman. -## 📚 Other Resources +## Other Resources - https://github.com/kewlfft/ansible-aur \ No newline at end of file diff --git a/roles/systemd-notifier-email/README.md b/roles/systemd-notifier-email/README.md index 58d8bfd0..a31fc144 100644 --- a/roles/systemd-notifier-email/README.md +++ b/roles/systemd-notifier-email/README.md @@ -19,6 +19,6 @@ The primary purpose of this role is to provide a comprehensive solution for auto - **Secure Notifications:** Integrates with systemd to trigger email alerts when services fail. - **Suite Integration:** Part of the `systemd-notifier` suite, offering a unified approach to service failure notifications. -## 📚 Other Resources +## Other Resources This role was created as part of a conversation with OpenAI's ChatGPT and can be found [here](https://chat.openai.com/share/96e4ca12-0888-41c0-9cfc-29c0180f0dba). diff --git a/roles/systemd-notifier-telegram/README.md b/roles/systemd-notifier-telegram/README.md index 16ca532f..09f0db2c 100644 --- a/roles/systemd-notifier-telegram/README.md +++ b/roles/systemd-notifier-telegram/README.md @@ -19,6 +19,6 @@ The primary purpose of this role is to provide a robust solution for automated T - **Secure Notifications:** Leverages systemd to trigger alerts automatically when services fail. - **Suite Integration:** Part of the [`systemd-notifier` suite](../) which includes related roles such as [systemd-notifier-email](../systemd-notifier-email/README.md) and others. -## 📚 Other Resources +## Other Resources This role was developed as part of a conversation with OpenAI's ChatGPT and can be found [here](https://chat.openai.com/share/96e4ca12-0888-41c0-9cfc-29c0180f0dba). diff --git a/roles/wireguard/Administration.md b/roles/wireguard/Administration.md index 2f4a1c67..0612050b 100644 --- a/roles/wireguard/Administration.md +++ b/roles/wireguard/Administration.md @@ -25,7 +25,7 @@ systemctl status wg-quick@wg0.cymais.service ``` -## 📚 Other Resources +## Other Resources - https://golb.hplar.ch/2019/01/expose-server-vpn.html - https://wiki.archlinux.org/index.php/WireGuard - https://wireguard.how/server/raspbian/