mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-03-26 03:03:32 +01:00
Updated Base Docu
This commit is contained in:
parent
275e4bd453
commit
80d99dfd18
@ -1,19 +1,26 @@
|
||||
# Features
|
||||
# Features 🚀
|
||||
|
||||
**CyMaIS - Cyber Master Infrastructure Solution** revolutionizes IT infrastructure management, making it simpler, safer, and more adaptable for businesses of all sizes. Here's how it can benefit your organization:
|
||||
**CyMaIS - Cyber Master Infrastructure Solution** revolutionizes IT infrastructure management, making it simpler, safer, and more adaptable for businesses of all sizes. Here’s how it can benefit your organization:
|
||||
|
||||
1. **Effortless Setup and Management**: CyMaIS makes setting up and managing IT systems a breeze. Whether you're using Linux servers or personal computers, our tool automates the process, saving you time and effort.
|
||||
## Effortless Setup and Management 🚀
|
||||
Setting up and managing IT systems has never been easier. CyMaIS automates complex tasks, whether on Linux servers or personal computers, reducing manual effort and saving valuable time.
|
||||
|
||||
2. **Everything You Need in One Place**: From the basics of system setup to advanced features like VPN and Docker, CyMaIS provides a complete range of tools. It's like having an IT expert at your fingertips, offering solutions for every need.
|
||||
## Comprehensive IT Solutions 🛠️
|
||||
CyMaIS covers everything from essential system setups to advanced configurations, including VPN, Docker, Ansible-based deployments, security optimizations, and monitoring tools. This makes IT management seamless and efficient.
|
||||
|
||||
3. **Tailored to Your Business**: We understand that every business is unique. That's why CyMaIS is designed to be flexible, with customizable options to fit your specific requirements, whether you're a start-up, a growing business, or an established enterprise.
|
||||
## Tailored for Your Needs 🎯
|
||||
Every business is unique, and so is CyMaIS! With a modular architecture, it adapts to specific requirements, whether for startups, growing businesses, NGOs, or large enterprises.
|
||||
|
||||
4. **Stay Ahead with Proactive Monitoring**: Our tool doesn't just set up your IT infrastructure; it keeps it running smoothly. With automated updates and proactive monitoring, you can rest assured that your systems are always up-to-date and performing optimally.
|
||||
## Proactive Monitoring & Maintenance 🔍
|
||||
With automated updates, system health checks, and security audits, CyMaIS ensures your infrastructure is always up-to-date and running smoothly. Roles such as `health-docker-container`, `health-btrfs`, and `health-nginx` help monitor system integrity.
|
||||
|
||||
5. **Uncompromised Security and Reliability**: Protecting your data is our top priority. CyMaIS comes with robust security features and comprehensive backup solutions, giving you peace of mind that your business's sensitive information is safe and secure.
|
||||
## Uncompromised Security 🔒
|
||||
Security is a top priority! CyMaIS includes robust security features like full-disk encryption recommendations, 2FA enforcement, encrypted server deployments (`docker-keycloak`, `docker-ldap`), and secure backup solutions (`backup-remote-to-local`, `backup-data-to-usb`).
|
||||
|
||||
6. **User-Friendly with Expert Support**: While familiarity with Docker, Linux, and Ansible enhances your experience with CyMaIS, it's not a requirement. Our comprehensive roles for servers and end-user PCs simplify the setup process. With these intuitive tools and our detailed guides, managing your IT infrastructure becomes more accessible, even if you're not a seasoned IT professional. Plus, our support team is always ready to assist you, bridging any knowledge gaps and ensuring a smooth operation of your systems.
|
||||
## User-Friendly with Expert Support 👩💻
|
||||
No need to be a Linux or Docker expert! CyMaIS simplifies deployment with intuitive role-based automation. Documentation and community support make IT administration accessible to all experience levels.
|
||||
|
||||
7. **Open Source Trust and Transparency**: With CyMaIS, you benefit from the reliability and security of open-source software. Our tool is transparent, community-driven, and aligned with the highest standards of software ethics and security.
|
||||
## Open Source Trust & Transparency 🔓
|
||||
As an open-source project, CyMaIS guarantees transparency, security, and community-driven development, ensuring continuous improvements and adherence to industry best practices.
|
||||
|
||||
CyMaIS is more than just an IT solution; it's a commitment to empowering your business with the technology it needs to thrive in today’s digital landscape, effortlessly and securely.
|
||||
For further information, check out the full [User Guide](04_USER_GUIDE.md) and [Enterprise Solutions](10_ENTERPRISE_SOLUTIONS.md).
|
||||
@ -1 +1,66 @@
|
||||
# User Guide
|
||||
# User Guide 📖
|
||||
|
||||
Welcome to **CyMaIS**! This guide is designed for **end-users** who want to use cloud services, email, and collaboration tools securely and efficiently. Whether you're an **enterprise user** or an **individual**, CyMaIS provides a wide range of services tailored to your needs.
|
||||
|
||||
## What Can CyMaIS Do for You? 💡
|
||||
CyMaIS enables you to securely and efficiently use a variety of **cloud-based applications**, including:
|
||||
|
||||
### 📂 Cloud Storage & File Sharing
|
||||
- **Nextcloud** – Securely store, sync, and share files across devices.
|
||||
- **OnlyOffice** – Work on documents, spreadsheets, and presentations directly within Nextcloud.
|
||||
- **LibreOffice** – A powerful office suite alternative to Microsoft Office.
|
||||
|
||||
### 💬 Secure Communication & Collaboration
|
||||
- **Matrix (Element)** – Encrypted messaging for teams and individuals.
|
||||
- **XMPP** – Secure instant messaging with various supported clients.
|
||||
- **Mailu** – A private, self-hosted email solution.
|
||||
- **Etherpad** – Real-time collaborative document editing.
|
||||
- **BigBlueButton** – Web conferencing with screen sharing and presentations.
|
||||
- **Jitsi** – Secure video conferencing without account requirements.
|
||||
|
||||
### 🎵 Social Media & Content Sharing
|
||||
- **Mastodon** – Decentralized microblogging platform (alternative to Twitter/X).
|
||||
- **Pixelfed** – Decentralized image sharing (alternative to Instagram).
|
||||
- **Friendica** – Social network supporting federation with Mastodon and others.
|
||||
- **Peertube** – Decentralized video streaming platform (alternative to YouTube).
|
||||
- **Funkwhale** – Self-hosted music streaming for individuals and communities.
|
||||
|
||||
### 🎮 Entertainment & Media
|
||||
- **Jellyfin** – Open-source media server for movies, TV, and music.
|
||||
- **Kodi** – Media center application with extensive plugin support.
|
||||
- **qBittorrent** – Open-source torrent client with secure remote access.
|
||||
|
||||
### 🔒 Privacy & Security
|
||||
- **WireGuard** – Secure and fast VPN solution.
|
||||
- **Tor Browser** – Browse the web anonymously and bypass censorship.
|
||||
- **Bitwarden** – Open-source password manager for secure credential storage.
|
||||
- **2FA Authentication** – Securely log in to your services with Two-Factor Authentication.
|
||||
|
||||
### 🔧 Developer & Productivity Tools
|
||||
- **Gitea** – Self-hosted Git repository management (alternative to GitHub/GitLab).
|
||||
- **Jenkins** – Automate software development pipelines.
|
||||
- **Discourse** – Community discussion forums for support and engagement.
|
||||
- **MediaWiki** – Create and manage knowledge bases and wikis.
|
||||
|
||||
## 🏢 Enterprise Users
|
||||
### How to Get Started 🏁
|
||||
If your organization provides CyMaIS services, follow these steps:
|
||||
- Your **administrator** will provide login credentials.
|
||||
- Access **cloud services** via a web browser or mobile apps.
|
||||
- For support, contact your **system administrator**.
|
||||
|
||||
## 🏠 Private Users
|
||||
### How to Get Started 🏁
|
||||
If you're an **individual user**, you can sign up for CyMaIS services:
|
||||
- **Register an account** at [cymais.cloud](https://cymais.cloud).
|
||||
- Choose the applications and services you need.
|
||||
- Follow the setup guide and start using CyMaIS services immediately.
|
||||
|
||||
## 📚 Learn More
|
||||
Discover more about CyMaIS applications:
|
||||
- :doc:`roles/application_glosar`
|
||||
- :doc:`roles/application_categories`
|
||||
|
||||
For further information, visit our **[Information Hub](https://hub.cymais.cloud)** for tutorials, FAQs, and community support.
|
||||
|
||||
You can also register for updates and support from our community.
|
||||
|
||||
@ -1,14 +1,16 @@
|
||||
# Customer Guide
|
||||
<img src="https://cybermaster.space/wp-content/uploads/sites/7/2023/11/FVG_8364BW-scaled.jpg" width="300" style="float: right; margin-left: 30px;">
|
||||
# Customer Guide 📋
|
||||
|
||||
My name is Kevin Veen-Birkenbach and I'm glad to assist you in the implementation of your secure and scalable IT infrastrucutre solution with CyMaIS.
|
||||
Are you looking for a **reliable IT infrastructure** for your business or organization? **CyMaIS** is here to help!
|
||||
|
||||
My expertise in server administration, digital corporate infrastructure, custom software, and information security, all underpinned by a commitment to Open Source solutions, guarantees that your IT setup meets the highest industry standards.
|
||||
### Who Can Benefit? 🎯
|
||||
✅ **Small & Medium Businesses** - Automate IT setup & security
|
||||
✅ **Enterprises** - Scale deployments with modular architecture
|
||||
✅ **NGOs & Organizations** - Secure, cost-effective infrastructure solutions
|
||||
|
||||
Discover how CyMaIS can transform your IT landscape.
|
||||
### Why Choose CyMaIS? 🚀
|
||||
- **Fast Deployment** - Get your IT setup running in minutes
|
||||
- **Security First** - Encrypted backups, 2FA, and secure logins
|
||||
- **Scalable & Customizable** - Adapts to your specific needs
|
||||
- **Cost-Effective** - Open-source, no licensing fees
|
||||
|
||||
Contact me for more details:
|
||||
|
||||
🌍 Website: [www.CyberMaster.Space](https://cybermaster.space)<br />
|
||||
📧 Email: [kevin@veen.world](mailto:kevin@veen.world)<br />
|
||||
☎️ Phone: [+ 49 178 179 80 23](tel:00491781798023)
|
||||
For enterprise solutions, check [Enterprise Solutions](10_ENTERPRISE_SOLUTIONS.md) or contact [Kevin Veen-Birkenbach](mailto:kevin@veen.world).
|
||||
|
||||
@ -1,4 +0,0 @@
|
||||
Developer Guide
|
||||
===============
|
||||
|
||||
To get an overview over all yaml files check out :doc:`docs/generated/yaml_index`.
|
||||
52
10_DEVELOPER_GUIDE.rst
Normal file
52
10_DEVELOPER_GUIDE.rst
Normal file
@ -0,0 +1,52 @@
|
||||
Developer Guide
|
||||
===============
|
||||
|
||||
Welcome to the **CyMaIS Developer Guide**! This guide provides essential information for developers who want to contribute to the CyMaIS open-source project.
|
||||
|
||||
Getting Started
|
||||
---------------
|
||||
To understand the overall structure of CyMaIS, start by reviewing the available YAML configuration files:
|
||||
|
||||
- :doc:`docs/generated/yaml_index`
|
||||
|
||||
Explore CyMaIS Solutions
|
||||
------------------------
|
||||
CyMaIS offers various solutions for IT infrastructure automation. Learn more about the available applications:
|
||||
|
||||
- :doc:`roles/application_glosar`
|
||||
- :doc:`roles/application_categories`
|
||||
|
||||
For Developers
|
||||
--------------
|
||||
### Understanding Ansible Roles
|
||||
CyMaIS is powered by **Ansible** roles to automate deployments. Developers can explore the technical details of our roles here:
|
||||
|
||||
- :doc:`roles/ansible_role_glosar`
|
||||
|
||||
### Contributing to CyMaIS
|
||||
Want to contribute to the project or explore the source code? Check out our **GitHub repository**:
|
||||
|
||||
- `CyMaIS GitHub Repository <https://github.com/kevinveenbirkenbach/cymais/tree/master/roles>`_
|
||||
|
||||
### Contribution Guidelines
|
||||
1. **Fork the Repository** – Start by forking the CyMaIS repository.
|
||||
2. **Create a New Branch** – Make changes in a dedicated branch.
|
||||
3. **Follow Coding Standards** – Ensure your code is well-documented and follows best practices.
|
||||
4. **Submit a Pull Request** – Once your changes are tested, submit a PR for review.
|
||||
|
||||
For detailed guidelines, refer to:
|
||||
|
||||
- :doc:`CONTRIBUTING`
|
||||
- :doc:`CODE_OF_CONDUCT`
|
||||
|
||||
Community & Support
|
||||
-------------------
|
||||
If you have questions or need help, visit the **CyMaIS Information Hub**:
|
||||
|
||||
- `hub.cymais.cloud <https://hub.cymais.cloud>`_
|
||||
|
||||
This is the best place to ask questions, get support, and collaborate with other contributors.
|
||||
|
||||
Stay connected, collaborate, and help improve CyMaIS together!
|
||||
|
||||
Happy coding! 🚀
|
||||
17
10_ENTERPRISE_SOLUTIONS.md
Normal file
17
10_ENTERPRISE_SOLUTIONS.md
Normal file
@ -0,0 +1,17 @@
|
||||
# Enterprise Solutions 🏢
|
||||
|
||||
**CyMaIS** provides powerful **enterprise-grade IT infrastructure solutions**, enabling businesses to scale securely and efficiently.
|
||||
|
||||
### How CyMaIS Helps Enterprises 🔧
|
||||
- **Automated Deployment** - Set up secure servers & workstations effortlessly
|
||||
- **Advanced Security** - Integrated 2FA, LDAP, encrypted storage
|
||||
- **High Availability** - Scalable infrastructure for growing enterprises
|
||||
- **Compliance & Audit Logs** - Maintain regulatory standards
|
||||
|
||||
### Use Cases 💼
|
||||
✅ **Cloud-Based Infrastructure** (Docker, Kubernetes, CI/CD pipelines)
|
||||
✅ **Enterprise Networking & VPN** (WireGuard, OpenVPN, Firewall rules)
|
||||
✅ **Database & Business Apps** (PostgreSQL, Nextcloud, ERP systems)
|
||||
✅ **Custom Security Solutions** (Keycloak, LDAP, 2FA enforcement)
|
||||
|
||||
Interested? Contact [Kevin Veen-Birkenbach](mailto:kevin@veen.world) to discuss tailored enterprise solutions.
|
||||
@ -1 +0,0 @@
|
||||
# Investor Informations
|
||||
15
11_INVESTOR_INFORMATIONS.md
Normal file
15
11_INVESTOR_INFORMATIONS.md
Normal file
@ -0,0 +1,15 @@
|
||||
# Investor Information 💰
|
||||
|
||||
🚀 **CyMaIS is seeking investors** to expand its reach and continue development. With an increasing demand for automated IT solutions, **CyMaIS has the potential to revolutionize IT infrastructure management.**
|
||||
|
||||
### Market Potential 📈
|
||||
- **$500B+ Global IT Infrastructure Market**
|
||||
- Growing **open-source adoption** across enterprises
|
||||
- Increasing need for **automation & cybersecurity**
|
||||
|
||||
### Why Invest in CyMaIS? 🔥
|
||||
- **Unique Automation Approach** - Pre-configured roles for quick IT setup
|
||||
- **Security & Compliance Focus** - Built-in security best practices
|
||||
- **Scalability** - Modular framework adaptable to various industries
|
||||
|
||||
Interested in investing? Contact **[Kevin Veen-Birkenbach](mailto:kevin@veen.world)** to discuss partnership opportunities.
|
||||
17
13_AUTHOR.md
Normal file
17
13_AUTHOR.md
Normal file
@ -0,0 +1,17 @@
|
||||
# Author
|
||||
|
||||
<img src="https://cybermaster.space/wp-content/uploads/sites/7/2023/11/FVG_8364BW-scaled.jpg" width="300" style="float: right; margin-left: 30px;">
|
||||
|
||||
My name is Kevin Veen-Birkenbach and I'm the author and founder of CyMaIS.
|
||||
|
||||
I'm glad to assist you in the implementation of your secure and scalable IT infrastrucutre solution with CyMaIS.
|
||||
|
||||
My expertise in server administration, digital corporate infrastructure, custom software, and information security, all underpinned by a commitment to Open Source solutions, guarantees that your IT setup meets the highest industry standards.
|
||||
|
||||
Discover how CyMaIS can transform your IT landscape.
|
||||
|
||||
Contact me for more details:
|
||||
|
||||
🌍 Website: [www.CyberMaster.Space](https://cybermaster.space)<br />
|
||||
📧 Email: [kevin@veen.world](mailto:kevin@veen.world)<br />
|
||||
☎️ Phone: [+ 49 178 179 80 23](tel:00491781798023)
|
||||
@ -8,7 +8,7 @@ There are several ways you can help:
|
||||
- **Reporting Issues:** Found a bug or have a feature request? Please open an issue on our [GitHub Issues page](https://github.com/kevinveenbirkenbach/cymais/issues) with a clear description and steps to reproduce the problem.
|
||||
- **Code Contributions:** If you'd like to contribute code, fork the repository, create a new branch for your feature or bug fix, and submit a pull request. Ensure your code adheres to our coding style and includes tests where applicable.
|
||||
- **Documentation:** Improving the documentation is a great way to contribute. Whether it's clarifying an existing section or adding new guides, your contributions help others understand and use CyMaIS effectively.
|
||||
- **Financial Contributions:** If you appreciate CyMaIS and want to support its ongoing development, consider making a financial contribution. For more details, please see our [donate options](11_DONATE.md).
|
||||
- **Financial Contributions:** If you appreciate CyMaIS and want to support its ongoing development, consider making a financial contribution. For more details, please see our [donate options](12_DONATE.md).
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
|
||||
36
README.md
36
README.md
@ -1,17 +1,35 @@
|
||||
# CyMaIS - Cyber Master Infrastructure Solution
|
||||
|
||||
Welcome to CyMaIS (Cyber Master Infrastructure Solution), a transformative tool designed to redefine IT infrastructure setup for organizations and individuals alike.
|
||||
# README.md
|
||||
|
||||
At its core, CyMaIS leverages the power of Docker, Linux, and Ansible to offer a streamlined, automated solution for deploying and managing IT systems.
|
||||
# CyMaIS - Cyber Master Infrastructure Solution 🚀
|
||||
|
||||
<img src="assets/img/logo.png" width="300" style="float: right; margin-left: 10px;">
|
||||
Welcome to **CyMaIS (Cyber Master Infrastructure Solution)**, a powerful automation framework that simplifies IT infrastructure setup and management. Whether you are an **end-user** looking to access cloud services securely or an **administrator** responsible for deploying and maintaining infrastructure, CyMaIS provides a seamless and secure solution.
|
||||
|
||||
Whether you're a small startup, a growing enterprise, or an individual seeking efficient IT management, CyMaIS provides a comprehensive suite of tools that cater to a wide range of needs. From simple system setups to complex server configurations and end-user PC management, CyMaIS simplifies the entire process.
|
||||
|
||||
|
||||
Our intuitive interface, coupled with in-depth documentation, makes it accessible to both tech-savvy users and those with limited IT experience.
|
||||
## What is CyMaIS? 📌
|
||||
CyMaIS leverages **Docker, Linux, and Ansible** to provide an automated and modular infrastructure solution. With more then **148 pre-configured roles**, it supports a wide range of applications, from cloud services to local server management and desktop workstation setups.
|
||||
|
||||
With CyMaIS, setting up a secure, scalable, and robust IT infrastructure is not just faster and easier, but also aligned with the best industry practices, ensuring that your organization stays ahead in the ever-evolving digital landscape.
|
||||
## Guides 📖
|
||||
- **[User Guide](04_USER_GUIDE.md)** - For end-users accessing cloud apps like Nextcloud, Matrix, and more.
|
||||
- **[Administrator Guide](06_ADMINISTRATOR_GUIDE.md)** - For system administrators deploying CyMaIS.
|
||||
|
||||
---
|
||||
## Key Features 🎯
|
||||
- **Automated IT deployment** 📦 - Pre-built roles for server and PC setups
|
||||
- **Enterprise-ready security** 🔒 - Supports LDAP, Keycloak, 2FA, and encrypted storage
|
||||
- **Scalability & flexibility** 📈 - Modular approach for small teams to large enterprises
|
||||
- **Backup & recovery solutions** 💾 - Automate data security and prevent loss
|
||||
- **Infrastructure monitoring & maintenance** 📊 - Keep your system running optimally
|
||||
|
||||
Feel free to explore the individual documents for more detailed information. Enjoy using CyMaIS, and thank you for your interest in our project!
|
||||
## Get Started 🚀
|
||||
1. **Install CyMaIS** via [Kevin's Package Manager](https://github.com/kevinveenbirkenbach/package-manager)
|
||||
2. **Setup CyMaIS** using:
|
||||
```sh
|
||||
pkgmgr setup cymais
|
||||
```
|
||||
3. **Explore Commands** with:
|
||||
```sh
|
||||
cymais --help
|
||||
```
|
||||
|
||||
For detailed setup instructions, check out the [Setup Guide](07_SETUP_GUIDE.md) and [Configuration Guide](08_CONFIGURATION.md).
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user