mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-08-30 23:38:13 +02:00
Renamed cymais to infinito and did some other optimations and logout implementations
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
|
||||
## Ansible Vault Basics
|
||||
|
||||
CyMaIS uses Ansible Vault to protect sensitive data (e.g. passwords). Use these common commands:
|
||||
Infinito.Nexus uses Ansible Vault to protect sensitive data (e.g. passwords). Use these common commands:
|
||||
|
||||
### Edit an Encrypted File
|
||||
```bash
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# 🚀 Deployment Guide
|
||||
|
||||
This section explains how to deploy and manage the **Cyber Master Infrastructure Solution (CyMaIS)** using Ansible. CyMaIS uses a collection of Ansible tasks, which are controlled via different **"modes"** — such as **updates**, **backups**, **resets**, and **cleanup** operations.
|
||||
This section explains how to deploy and manage the **Cyber Master Infrastructure Solution (Infinito.Nexus)** using Ansible. Infinito.Nexus uses a collection of Ansible tasks, which are controlled via different **"modes"** — such as **updates**, **backups**, **resets**, and **cleanup** operations.
|
||||
|
||||
---
|
||||
|
||||
@@ -9,27 +9,27 @@ This section explains how to deploy and manage the **Cyber Master Infrastructure
|
||||
Before deploying, ensure the following are in place:
|
||||
|
||||
- **🧭 Inventory File:** A valid Ansible inventory file that defines your target systems (servers, personal computers, etc.). Adjust example paths to your environment.
|
||||
- **📦 CyMaIS Installed:** Install via [Kevin's Package-Manager](https://github.com/kevinveenbirkenbach/package-manager).
|
||||
- **📦 Infinito.Nexus Installed:** Install via [Kevin's Package-Manager](https://github.com/kevinveenbirkenbach/package-manager).
|
||||
- **🔐 (Optional) Vault Password File:** If you don't want to enter your vault password interactively, create a password file.
|
||||
|
||||
---
|
||||
|
||||
## 📘 Show CyMaIS Help
|
||||
## 📘 Show Infinito.Nexus Help
|
||||
|
||||
To get a full overview of available options and usage instructions, run:
|
||||
|
||||
```bash
|
||||
cymais --help
|
||||
infinito --help
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 💡 Example Deploy Command
|
||||
|
||||
To deploy CyMaIS on a personal computer (e.g., a laptop), you can run:
|
||||
To deploy Infinito.Nexus on a personal computer (e.g., a laptop), you can run:
|
||||
|
||||
```bash
|
||||
cymais playbook \
|
||||
infinito playbook \
|
||||
--limit hp-spectre-x360 \
|
||||
--host-type personal-computer \
|
||||
--update \
|
||||
@@ -41,7 +41,7 @@ cymais playbook \
|
||||
|
||||
| Parameter | Description |
|
||||
|----------|-------------|
|
||||
| `playbook` | Executes the playbook subcommand of CyMaIS. |
|
||||
| `playbook` | Executes the playbook subcommand of Infinito.Nexus. |
|
||||
| `--limit hp-spectre-x360` | Limits execution to a specific host (`hp-spectre-x360`). |
|
||||
| `--host-type personal-computer` | Defines the host type. Default is `server`; here it is set to `personal-computer`. |
|
||||
| `--update` | Enables update mode to apply software or configuration updates. |
|
||||
@@ -64,7 +64,7 @@ To avoid typing your vault password interactively, you can provide a file:
|
||||
|
||||
## 🔍 Full Command-Line Reference
|
||||
|
||||
Here’s a breakdown of all available parameters from `cymais playbook --help`:
|
||||
Here’s a breakdown of all available parameters from `infinito playbook --help`:
|
||||
|
||||
| Argument | Description |
|
||||
|----------|-------------|
|
||||
@@ -87,7 +87,7 @@ Here’s a breakdown of all available parameters from `cymais playbook --help`:
|
||||
You can mix and match modes like this:
|
||||
|
||||
```bash
|
||||
cymais playbook --update --backup --cleanup pcs.yml
|
||||
infinito playbook --update --backup --cleanup pcs.yml
|
||||
```
|
||||
|
||||
This will update the system, create a backup, and clean up unnecessary files in one run.
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
# Administrator Guide
|
||||
|
||||
This guide is for **system administrators** who are deploying and managing CyMaIS infrastructure.
|
||||
This guide is for **system administrators** who are deploying and managing Infinito.Nexus infrastructure.
|
||||
|
||||
## Setting Up CyMaIS 🏗️
|
||||
Follow these guides to install and configure CyMaIS:
|
||||
## Setting Up Infinito.Nexus 🏗️
|
||||
Follow these guides to install and configure Infinito.Nexus:
|
||||
- [Setup Guide](SETUP_GUIDE.md)
|
||||
- [Configuration Guide](CONFIGURATION.md)
|
||||
- [Deployment Guide](DEPLOY.md)
|
||||
@@ -14,7 +14,7 @@ Follow these guides to install and configure CyMaIS:
|
||||
- **Application Hosting** - Deploy services like `Nextcloud`, `Matrix`, `Gitea`, and more.
|
||||
- **Networking & VPN** - Configure `WireGuard`, `OpenVPN`, and `Nginx Reverse Proxy`.
|
||||
|
||||
## Managing & Updating CyMaIS 🔄
|
||||
## Managing & Updating Infinito.Nexus 🔄
|
||||
- Regularly update services using `update-docker`, `update-pacman`, or `update-apt`.
|
||||
- Monitor system health with `sys-hlth-btrfs`, `sys-hlth-webserver`, and `sys-hlth-docker-container`.
|
||||
- Automate system maintenance with `sys-lock`, `sys-cln-bkps-service`, and `sys-rpr-docker-hard`.
|
||||
|
||||
@@ -1,27 +1,27 @@
|
||||
# Security Guidelines
|
||||
|
||||
CyMaIS is designed with security in mind. However, while following our guidelines can greatly improve your system’s security, no IT system can be 100% secure. Please report any vulnerabilities as soon as possible.
|
||||
Infinito.Nexus is designed with security in mind. However, while following our guidelines can greatly improve your system’s security, no IT system can be 100% secure. Please report any vulnerabilities as soon as possible.
|
||||
|
||||
Additional to the user securitry guidelines administrators have additional responsibilities to secure the entire system:
|
||||
|
||||
- **Deploy on an Encrypted Server**
|
||||
It is recommended to install CyMaIS on an encrypted server to prevent hosting providers from accessing end-user data. For a practical guide on setting up an encrypted server, refer to the [Hetzner Arch LUKS repository](https://github.com/kevinveenbirkenbach/hetzner-arch-luks) 🔐. (Learn more about [disk encryption](https://en.wikipedia.org/wiki/Disk_encryption) on Wikipedia.)
|
||||
It is recommended to install Infinito.Nexus on an encrypted server to prevent hosting providers from accessing end-user data. For a practical guide on setting up an encrypted server, refer to the [Hetzner Arch LUKS repository](https://github.com/kevinveenbirkenbach/hetzner-arch-luks) 🔐. (Learn more about [disk encryption](https://en.wikipedia.org/wiki/Disk_encryption) on Wikipedia.)
|
||||
|
||||
- **Centralized User Management & SSO**
|
||||
For robust authentication and central user management, set up CyMaIS using Keycloak and LDAP.
|
||||
For robust authentication and central user management, set up Infinito.Nexus using Keycloak and LDAP.
|
||||
This configuration enables centralized [Single Sign-On (SSO)](https://en.wikipedia.org/wiki/Single_sign-on) (SSO), simplifying user management and boosting security.
|
||||
|
||||
- **Enforce 2FA and Use a Password Manager**
|
||||
Administrators should also enforce [2FA](https://en.wikipedia.org/wiki/Multi-factor_authentication) and use a password manager with auto-generated passwords. We again recommend [KeePass](https://keepass.info/). The KeePass database can be stored securely in your Nextcloud instance and synchronized between devices.
|
||||
|
||||
- **Avoid Root Logins & Plaintext Passwords**
|
||||
CyMaIS forbids logging in via the root user or using simple passwords. Instead, an SSH key must be generated and transferred during system initialization. When executing commands as root, always use `sudo` (or, if necessary, `sudo su`—but only if you understand the risks). (More information on [SSH](https://en.wikipedia.org/wiki/Secure_Shell) and [sudo](https://en.wikipedia.org/wiki/Sudo) is available on Wikipedia.)
|
||||
Infinito.Nexus forbids logging in via the root user or using simple passwords. Instead, an SSH key must be generated and transferred during system initialization. When executing commands as root, always use `sudo` (or, if necessary, `sudo su`—but only if you understand the risks). (More information on [SSH](https://en.wikipedia.org/wiki/Secure_Shell) and [sudo](https://en.wikipedia.org/wiki/Sudo) is available on Wikipedia.)
|
||||
|
||||
- **Manage Inventories Securely**
|
||||
Your inventories for running CyMaIS should be managed in a separate repository and secured with tools such as [Ansible Vault](https://en.wikipedia.org/wiki/Encryption) 🔒. Sensitive credentials must never be stored in plaintext; use a password file to secure these details.
|
||||
Your inventories for running Infinito.Nexus should be managed in a separate repository and secured with tools such as [Ansible Vault](https://en.wikipedia.org/wiki/Encryption) 🔒. Sensitive credentials must never be stored in plaintext; use a password file to secure these details.
|
||||
|
||||
- **Reporting Vulnerabilities**
|
||||
If you discover a security vulnerability in CyMaIS, please report it immediately. We encourage proactive vulnerability reporting so that issues can be addressed as quickly as possible. Contact our security team at [security@cymais.cloud](mailto:security@cymais.cloud)
|
||||
If you discover a security vulnerability in Infinito.Nexus, please report it immediately. We encourage proactive vulnerability reporting so that issues can be addressed as quickly as possible. Contact our security team at [security@infinito.nexus](mailto:security@infinito.nexus)
|
||||
**DO NOT OPEN AN ISSUE.**
|
||||
|
||||
---
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
# Setup Guide
|
||||
|
||||
To setup CyMaIS follow this steps:
|
||||
To setup Infinito.Nexus follow this steps:
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before you setup CyMaIS you need to install [Kevin's Package Manager](https://github.com/kevinveenbirkenbach/package-manager).
|
||||
Before you setup Infinito.Nexus you need to install [Kevin's Package Manager](https://github.com/kevinveenbirkenbach/package-manager).
|
||||
Follow the installation instruction descriped [here](https://github.com/kevinveenbirkenbach/package-manager)
|
||||
|
||||
## Setup CyMaIS
|
||||
## Setup Infinito.Nexus
|
||||
|
||||
To setup CyMaIS execute:
|
||||
To setup Infinito.Nexus execute:
|
||||
|
||||
```bash
|
||||
pkgmgr install cymais
|
||||
pkgmgr install infinito
|
||||
```
|
||||
|
||||
This command will setup CyMaIS on your system with the alias **cymais**.
|
||||
This command will setup Infinito.Nexus on your system with the alias **infinito**.
|
||||
|
||||
## Get Help
|
||||
|
||||
After you setuped CyMaIS you can receive more help by executing:
|
||||
After you setuped Infinito.Nexus you can receive more help by executing:
|
||||
|
||||
```bash
|
||||
cymais --help
|
||||
infinito --help
|
||||
```
|
||||
Reference in New Issue
Block a user