mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-08-29 15:06:26 +02:00
Removed docs folder
This commit is contained in:
@@ -1,80 +0,0 @@
|
||||
# Common Applications
|
||||
This section outlines the common applications tailored for both servers and end-users, offering a wide range of functionalities to enhance system performance, security, and usability.
|
||||
|
||||
## Base Setup
|
||||
Key for initial system configuration, this section includes hostname setting, systemd journal management, locale configurations, and swapfile handling. Essential for both server and end-user setups, it ensures a solid foundation for system operations.
|
||||
|
||||
- **[Hostname](./roles/hostname/)**: Sets the system's hostname.
|
||||
- **[Journalctl](./roles/journalctl/)**: Configures systemd journal settings.
|
||||
- **[Locales](./roles/locales/)**: Configures system locales.
|
||||
- **[System-Swapfile](./roles/system-swapfile/)**: Configures swapfile creation and management.
|
||||
|
||||
## Administration Tools
|
||||
These tools are crucial for effective system administration, encompassing Git setup, Linux admin tools, and sudo configuration, suitable for both server environments and power users.
|
||||
|
||||
- **[Git](./roles/git/)**: Basic Git version control system setup.
|
||||
- **[Administrator-Tools](./roles/pc-administrator-tools/)**: Installs basic Linux administration tools.
|
||||
- **[Sudo](./roles/sudo/)**: Installs and configures sudo.
|
||||
|
||||
## Update
|
||||
This category focuses on automated updates and maintenance for the system and its components, including package managers and Docker containers, ensuring systems are up-to-date and secure.
|
||||
|
||||
- **[update](./roles/update/)**: Automates the process of system updates.
|
||||
- **[update-apt](./roles/update-apt/)**: Updates system packages using apt (for Debian-based systems).
|
||||
- **[update-docker](./roles/update-docker/)**: Keeps Docker containers up to date.
|
||||
- **[update-pacman](./roles/update-pacman/)**: Updates system packages using Pacman (for Arch-based systems).
|
||||
- **[update-yay](./roles/update-yay/)**: Updates system packages using yay.
|
||||
|
||||
## Driver
|
||||
Caters to a range of devices and needs for hardware driver installation and configuration, an integral part for both server hardware optimization and end-user device functionality.
|
||||
|
||||
- **[driver-epson-multiprinter](./roles/driver-epson-multiprinter/)**: Installs drivers for Epson multi-function printers.
|
||||
- **[driver-intel](./roles/driver-intel/)**: Installs Intel drivers, typically for graphics and other hardware.
|
||||
- **[driver-msi-keyboard-color](./roles/driver-msi-keyboard-color/)**: Configures MSI keyboard color settings.
|
||||
- **[driver-non-free](./roles/driver-non-free/)**: Installs non-free drivers, generally for specific hardware needs.
|
||||
|
||||
## Security
|
||||
Enhances system security with roles focused on security measures, user configurations, and SSH settings. It's vital for protecting both server environments and end-user systems.
|
||||
- **[System Security](./roles/system-security/)**: Enhances overall system security.
|
||||
- **[User Administrator](./roles/user-administrator/)**: Setup for system administrator user.
|
||||
- **[PC SSH](./roles/pc-ssh/)**: Configuration of SSH for secure remote access.
|
||||
- **[SSHD](./roles/sshd/)**: Configures SSH daemon settings.
|
||||
- **[System Maintenance Lock](./roles/system-maintenance-lock)**: Locks maintenance services to prevent dangerous inteactions between services
|
||||
|
||||
## Virtual Private Network (VPN)
|
||||
Centers on VPN configurations for secure and efficient network connectivity, particularly crucial for remote server access and end-users needing secure connections.
|
||||
- **[client-wireguard](./roles/client-wireguard/)**: Configures Wireguard VPN client.
|
||||
- **[client-wireguard-behind-firewall](./roles/client-wireguard-behind-firewall/)**: Sets up Wireguard client functionality behind a firewall.
|
||||
- **[wireguard](./roles/wireguard/)**: Installs and configures Wireguard for secure VPN connections.
|
||||
|
||||
## Notifier
|
||||
Sets up system event notifications via email and Telegram, a versatile feature for server administrators and end-users alike to stay informed about their system's status.
|
||||
- **[Systemd-Notifier](./roles/systemd-notifier/)**: Notifier service for systemd.
|
||||
- **[Systemd-Notifier-Email](./roles/systemd-notifier-email/)**: Email notifications for systemd services.
|
||||
- **[Systemd-Notifier-Telegram](./roles/systemd-notifier-telegram/)**: Telegram notifications for systemd services.
|
||||
|
||||
## Backup Solutions
|
||||
Focuses on comprehensive backup strategies and cleanup procedures, encompassing data backups, remote server backups, and maintenance of backup storage efficiency, crucial for data integrity in both servers and personal devices.
|
||||
|
||||
### Backups
|
||||
For USB devices, Docker volumes, remote servers, and user configurations.
|
||||
- **[backup-data-to-usb](./roles/backup-data-to-usb/)**: Automates data backup to USB devices.
|
||||
- **[backup-docker-to-local](./roles/backup-docker-to-local/)**: Backs up Docker volumes to local storage.
|
||||
- **[backup-remote-to-local](./roles/backup-remote-to-local/)**: Pulls backups from remote servers for local storage.
|
||||
- **[backups-provider](./roles/backups-provider/)**: Manages backup processes and storage solutions.
|
||||
- **[backups-provider-user](./roles/backups-provider-user/)**: Creates and configures users for backup processes.
|
||||
|
||||
### Backups Cleanup
|
||||
Manages disk space and cleans up old or failed backups.
|
||||
- **[cleanup-backups-service](./roles/cleanup-backups-service/)**: Service to clean up old backups automatically.
|
||||
- **[cleanup-backups-timer](./roles/cleanup-backups-timer/)**: Timer for scheduling the backup cleanup service.
|
||||
- **[cleanup-disc-space](./roles/cleanup-disc-space/)**: Manages and frees up disk space on the system.
|
||||
- **[cleanup-failed-docker-backups](./roles/cleanup-failed-docker-backups/)**: Cleans up failed Docker backups.
|
||||
|
||||
## Other
|
||||
Encompasses miscellaneous essential tools and systems, including package management, spellchecking, and typesetting, beneficial for both server maintenance and enhancing end-user experience.
|
||||
- **[System-Aur-Helper](./roles/system-aur-helper/)**: Installs and configures AUR helper (yay).
|
||||
- **[Hunspell](./roles/hunspell/)**: Installation of Hunspell spellchecker.
|
||||
- **[Latex](./roles/pc-latex/)**: Installation of LaTeX typesetting system.
|
||||
- **[Java](./roles/java/)**: Installs Java Development Kit (JDK).
|
||||
- **[Python Pip](./roles/python-pip/)**: Installation of Python Pip package manager.
|
||||
@@ -1,46 +0,0 @@
|
||||
# End User Applications
|
||||
End User Applications provide a diverse suite of tools and software designed to enhance the computing experience for personal computer users, including those using desktops and laptops. These applications cover various aspects such as multimedia, productivity, virtualization, and more, catering to the everyday needs of end users.
|
||||
|
||||
## Common Applications
|
||||
In addition to the specialized software found in this document, the [COMMON_APPLICATIONS.md](./COMMON_APPLICATIONS.md) offers a comprehensive range of functionalities that cater to both server and end-user needs. This section enhances system performance, security, and usability with a variety of tools and configurations suitable for diverse computing environments.
|
||||
|
||||
## Desktop
|
||||
This category focuses on tools and configurations that enhance the desktop computing experience. It includes utilities to maintain system activity, and software for optimizing the desktop environment, ensuring a seamless and user-friendly interface for day-to-day computer usage.
|
||||
- **[Caffeine](./roles/pc-caffeine/)**: Utility to keep your computer awake.
|
||||
- **[Gnome](./roles/pc-gnome/)**: Installation and configuration of Gnome desktop environment.
|
||||
|
||||
## Entertainment
|
||||
Geared towards leisure and entertainment, this section includes software for playing Blu-ray media, accessing a vast collection of music, and installing various computer games. It's designed to enrich your personal computing experience with multimedia enjoyment and gaming.
|
||||
- **[Bluray Player Tools](./roles/pc-bluray-player-tools/)**: Software for playing Blu-ray media on personal computers.
|
||||
- **[Spotify](./roles/pc-spotify/)**: Installation of Spotify for music streaming.
|
||||
- **[Games](./roles/pc-games/)**: Installation of various computer games.
|
||||
|
||||
## Office
|
||||
This segment caters to professional productivity needs. It encompasses a range of office-related software, from comprehensive office suites and video conferencing tools to cloud storage solutions, facilitating efficient and organized work in various office environments.
|
||||
- **[LibreOffice](./roles/pc-libreoffice/)**: Installation of the LibreOffice suite.
|
||||
- **[Office](./roles/pc-office/)**: Various office productivity tools.
|
||||
- **[Video Conference](./roles/pc-video-conference/)**: Video conferencing software setup.
|
||||
- **[Nextcloud Client](./roles/pc-nextcloud/)**: Client setup for Nextcloud cloud storage service.
|
||||
- **[GnuCash](./roles/pc-gnucash/)**: Software to manage finances
|
||||
- **[Jrnl](./roles/pc-jrnl/)**: CLI Journaling
|
||||
|
||||
## Anonymization
|
||||
Focusing on privacy and security, the Anonymization section offers tools for secure file sharing and anonymous web browsing. It includes software solutions that prioritize user privacy, ensuring secure online activities and data protection.
|
||||
- **[Qbittorrent](./roles/pc-qbittorrent/)**: Installation of qBittorrent for file sharing.
|
||||
- **[Torbrowser](./roles/pc-torbrowser/)**: Installation of Tor Browser for anonymous browsing.
|
||||
|
||||
## Content Creation
|
||||
Dedicated to creatives and content producers, this category provides tools essential for video streaming, recording, graphic design, and 3D modeling. It's tailored for those involved in digital content creation, offering the necessary software to bring creative projects to life.
|
||||
- **[Streaming Tools](./roles/pc-streaming-tools/)**: Software for video streaming and recording.
|
||||
- **[Designer Tools](./roles/pc-designer-tools/)**: Graphic design and 3D modeling software.
|
||||
|
||||
## Development Environment
|
||||
Targets software developers with tools and environments for various programming languages and development needs.
|
||||
- **[Developer Tools](./roles/pc-developer-tools/)**: Basic developer tools setup.
|
||||
- **[Developer Tools for Arduino](./roles/pc-developer-tools-arduino/)**: Setup for Arduino development.
|
||||
- **[Developer Tools for Bash](./roles/pc-developer-tools-bash/)**: Tools for Bash scripting.
|
||||
- **[Developer Tools for Java](./roles/pc-developer-tools-java/)**: Java development environment setup.
|
||||
- **[Developer Tools for PHP](./roles/pc-developer-tools-php/)**: PHP development environment setup.
|
||||
- **[Developer Tools for Python](./roles/pc-developer-tools-python/)**: Python development environment setup.
|
||||
- **[Virtual Box](./roles/pc-virtual-box/)**: VirtualBox setup for creating virtual machines.
|
||||
- **[Network Analyze Tools](./roles/pc-network-analyze-tools/)**: Network analysis and troubleshooting utilities.
|
||||
@@ -1,96 +0,0 @@
|
||||
# Server Applications
|
||||
Server applications encompass a wide array of functionalities designed to enhance the performance, reliability, and usability of server infrastructures. These applications are essential for maintaining server health, managing web services, facilitating containerization, and providing various tools for specific server needs.
|
||||
|
||||
## Common Applications
|
||||
For a detailed overview of the broad spectrum of server applications, including base setup, administration tools, update mechanisms, driver installations, security enhancements, VPN configurations, notifier services, backup solutions, and other essential tools and systems, please refer to the **[COMMON_APPLICATIONS.md](./COMMON_APPLICATIONS.md)**. This document provides insights into categories and specific roles catered to both server and end-user environments, ensuring comprehensive server management and optimization.
|
||||
|
||||
## Server Health
|
||||
Addresses server maintenance and health monitoring, ensuring optimal performance and reliability of the server infrastructure.
|
||||
- **[Health Btrfs](./roles/health-btrfs/)**: Monitors the health of Btrfs filesystems.
|
||||
- **[Health Disc Space](./roles/health-disc-space/)**: Checks for available disk space.
|
||||
- **[Health Docker Container](./roles/health-docker-container/)**: Monitors the health of Docker containers.
|
||||
- **[Health Docker Volumes](./roles/health-docker-volumes/)**: Checks the status of Docker volumes.
|
||||
- **[Health Journalctl](./roles/health-journalctl/)**: Monitors and manages the system journal.
|
||||
- **[Health Nginx](./roles/health-nginx/)**: Ensures the Nginx server is running smoothly.
|
||||
- **[Heal Docker](./roles/heal-docker/)**: Automated healing and maintenance tasks for Docker.
|
||||
|
||||
## Webserver
|
||||
Focuses on web server roles and applications, covering SSL certificates, Nginx configurations, reverse proxies, and email services.
|
||||
- **[Letsencrypt](./roles/letsencrypt/)**: Configures Let's Encrypt for SSL certificates.
|
||||
- **[Nginx](./roles/nginx/)**: Installs and configures Nginx web server.
|
||||
- **[Nginx-Docker-Reverse-Proxy](./roles/nginx-docker-reverse-proxy/)**: Sets up a reverse proxy for Docker containers.
|
||||
- **[nginx-serve-html](./roles/nginx-serve-html/)**: Configures a homepage for Nginx.
|
||||
- **[Nginx-Https](./roles/nginx-https/)**: Enables HTTPS configuration for Nginx.
|
||||
- **[nginx-modifier-matomo](./roles/nginx-modifier-matomo/)**: Integrates Matomo tracking with Nginx.
|
||||
- **[nginx-redirect-domain](./roles/nginx-redirect-domain/)**: Manages URL redirects in Nginx.
|
||||
- **[nginx-redirect-www](./roles/nginx-redirect-www/)**: Redirects all domains with the prefix www. from www.domain.tld to domain.tld
|
||||
- **[Nginx-Certbot](./roles/nginx-certbot/)**: Integrates Certbot with Nginx for SSL certificates.
|
||||
- **[Postfix](./roles/postfix/)**: Setup for the Postfix mail transfer agent.
|
||||
|
||||
## Docker and Containerization
|
||||
Dedicated to Docker container setups and application management, offering a wide array of software deployment options.
|
||||
- **[Docker](./roles/docker/)**: Basic Docker and Docker Compose setup.
|
||||
|
||||
### Finance and Project Management
|
||||
Facilitating the deployment of finance-related and project management applications.
|
||||
- **[Docker Akaunting](./roles/docker-akaunting/)**: Deployment of the Akaunting finance software.
|
||||
- **[Open Project](./roles/docker-openproject)**: Project Management Software
|
||||
- **[Taiga](./roles/docker-taiga)**: Scrum and Kanban Software
|
||||
|
||||
### Continues Integration and Continues Delivery
|
||||
Setups for development platforms and version control systems.
|
||||
- **[Gitea](./roles/docker-gitea/)**: Setup for the Gitea git server.
|
||||
- **[Jenkins](./roles/docker-jenkins/)**: Jenkins automation server setup.
|
||||
- **[ELK](./roles/docker-elk/)**: Elasticsearch, Logstash, and Kibana (ELK) stack setup.
|
||||
|
||||
### Content Management
|
||||
Deployment of various content management systems for web platforms.
|
||||
- **[Wordpress](./roles/docker-wordpress/)**: Wordpress blog and website platform setup.
|
||||
- **[Joomla](./roles/docker-joomla/)**: Joomla content management system setup.
|
||||
|
||||
### Fediverse Networks
|
||||
Implementing federated and decentralized social platforms.
|
||||
- **[Funkwhale](./roles/docker-funkwhale/)**: Deployment of Funkwhale, a federated music streaming server.
|
||||
- **[Mastodon](./roles/docker-mastodon/)**: Deployment of the Mastodon social network server.
|
||||
- **[Peertube](./roles/docker-peertube/)**: Deployment of the PeerTube video platform.
|
||||
- **[Pixelfed](./roles/docker-pixelfed/)**: Pixelfed, a federated image sharing platform, setup.
|
||||
|
||||
### Analytics Solutions
|
||||
Tools for web and data analytics.
|
||||
- **[Matomo](./roles/docker-matomo/)**: Setup for Matomo, an open-source analytics platform.
|
||||
|
||||
### Forum Software
|
||||
Deployments for community-driven forum platforms.
|
||||
- **[MyBB](./roles/docker-mybb/)**: Setup for MyBB forum software.
|
||||
- **[Discourse](./roles/docker-discourse/)**: Setup of Discouse a forum and community platform.
|
||||
|
||||
### Wiki and Documentation
|
||||
Setting up platforms for collaborative information sharing.
|
||||
- **[MediaWiki](./roles/docker-mediawiki/)**: MediaWiki setup for creating wikis.
|
||||
|
||||
### Event and Shop Management
|
||||
Tools for managing events and online retail.
|
||||
- **[Attendize](./roles/docker-attendize/)**: Setup for the Attendize event management tool.
|
||||
|
||||
### Data and Cloud Storage
|
||||
Solutions for data management and cloud-based storage.
|
||||
- **[Baserow](./roles/docker-baserow/)**: Deployment of Baserow, an open-source no-code database tool.
|
||||
- **[Nextcloud](./roles/docker-nextcloud/)**: Cloud storage solution setup.
|
||||
|
||||
### Communication and Collaboration
|
||||
Platffor enhancing communication and collaborative efforts.
|
||||
- **[BigBlueButton](./roles/docker-bigbluebutton/)**: Setup for the BigBlueButton video conferencing tool.
|
||||
- **[Mailu](./roles/docker-mailu/)**: Complete mail server solution.
|
||||
- **[Matrix](./roles/docker-matrix/)**: Setup and deployment of the Matrix server for secure, decentralized communication.
|
||||
|
||||
### Marketing and Communication Tools
|
||||
Focusing on tools that assist in communication, marketing, and outreach efforts.
|
||||
- **[Listmonk](./roles/docker-listmonk/)**: Setup for Listmonk, a self-hosted newsletter and mailing list manager.
|
||||
|
||||
### Web Utilities and Services
|
||||
Encompassing tools that enhance web functionality or provide essential web services.
|
||||
- **[YOURLS](./roles/docker-yourls/)**: Setup for YOURLS, a URL shortening service.
|
||||
|
||||
### Miscellaneous
|
||||
Diverse tools for specific needs and utilities.
|
||||
- **[Roulette Wheel](./roles/docker-roulette-wheel/)**: Setup for a custom roulette wheel application.
|
||||
@@ -1,17 +0,0 @@
|
||||
# Vision Statement
|
||||
|
||||
At the heart of our endeavor lies the creation of an unparalleled tool, designed to revolutionize the way IT infrastructure is deployed and managed in businesses of all scales and across various industries. Our vision is to develop a fully automated solution capable of establishing a secure and infinitely scalable corporate IT infrastructure.
|
||||
|
||||
This tool, grounded firmly in Open Source principles, will not only champion transparency and innovation but also ensure adaptability and accessibility for every business, regardless of its size or industry. We aim to make the complex process of IT setup not just simpler but also faster.
|
||||
|
||||
We envision a future where businesses are no longer constrained by the complexities of IT infrastructure setup. Instead, they will be empowered with a tool that seamlessly integrates into their operational fabric, offering a robust, secure, and scalable digital backbone. This tool will not only cater to the immediate IT needs of a company but also be agile enough to evolve with their growing demands and the ever-changing technological landscape.
|
||||
|
||||
Our commitment is to break down barriers to advanced IT infrastructure, democratizing access to high-level technology solutions. By harnessing the power of Open Source, our solution will not only uphold the highest standards of security and scalability but also foster a community-driven approach to continuous improvement and innovation.
|
||||
|
||||
In essence, our vision is to redefine the paradigm of IT infrastructure deployment, making it a swift, secure, and scalable journey for every business, and setting a new benchmark in the industry for efficiency and reliability.
|
||||
|
||||
---
|
||||
|
||||
Kevin Veen-Birkenbach
|
||||
Berlin
|
||||
2023-12-13
|
||||
Reference in New Issue
Block a user