From b6e91c914f8cb82a7a9c1cb284e4c32bab2611d6 Mon Sep 17 00:00:00 2001 From: zenaku Date: Tue, 4 Aug 2026 03:25:49 +0000 Subject: [PATCH] =?UTF-8?q?A=C3=B1adir=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 161 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 161 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..df4bb77 --- /dev/null +++ b/README.md @@ -0,0 +1,161 @@ +# Operator Setup Flow + +[🇺🇸 English](#english) · [🇪🇸 Español](#español) + +--- + +# English + +# Operator Setup Flow + +Three scripts must be executed in order on a fresh server. Each script runs only once and prepares the environment for the next step. + +--- + +## 00-setup-root.sh — Root + +Run as **root**. This script prepares the server and creates the operator user. + +```bash +bash 00-setup-root.sh +``` + +### What it does + +- Updates system packages +- Installs all required dependencies (Docker, Nginx, Certbot, UFW, OpenSSL) +- Configures Quad9 (`9.9.9.9`) as the DNS resolver +- Configures the UFW firewall with all required ports +- Creates the Linux operator user and adds it to the `sudo` and `docker` groups +- Copies `01-setup-user.sh` and `02-install.sh` into the new user's home directory + +After this script finishes, log in as the newly created user and run `01-setup-user.sh`. + +--- + +## 01-setup-user.sh — Operator User + +Run as the **operator user** (not root). This script generates the SSH key required to clone the private repository. + +```bash +bash ~/01-setup-user.sh +``` + +### What it does + +- Detects IPv4 and IPv6 availability +- Generates an `ed25519` SSH key pair +- Displays the public SSH key and IPv6 status + +> **Send the public SSH key and IPv6 status to Simplified Privacy, then wait until your key has been authorized before continuing.** + +--- + +## 02-install.sh — Operator User + +Run only after Simplified Privacy has authorized your SSH key. + +```bash +bash ~/02-install.sh +``` + +### What it does + +- Clones the private `operator-docker` repository +- Executes: + +```bash +sudo bash install.sh +``` + +From this point, the main installer takes over. + +**Read the `operator-docker` `README.md` (available in both English and Spanish) for installation details and post-installation instructions.** + +--- + +## Notes + +- Scripts **must** be executed in this order: `00` → `01` → `02` +- `00` must be run as **root** +- `01` and `02` must be run as the **operator user** +- Do **not** run `02` until Simplified Privacy confirms that your SSH key has been authorized + +--- + +# Español + +# Flujo de configuración del operador + +Tres scripts deben ejecutarse en orden sobre un servidor limpio. Cada uno se ejecuta una sola vez y prepara el entorno para el siguiente paso. + +--- + +## 00-setup-root.sh — Root + +Ejecutar como **root**. Este script prepara el servidor y crea el usuario operador. + +```bash +bash 00-setup-root.sh +``` + +### Qué hace + +- Actualiza los paquetes del sistema +- Instala todas las dependencias necesarias (Docker, Nginx, Certbot, UFW y OpenSSL) +- Configura Quad9 (`9.9.9.9`) como servidor DNS +- Configura el firewall UFW con todos los puertos requeridos +- Crea el usuario Linux del operador y lo agrega a los grupos `sudo` y `docker` +- Copia `01-setup-user.sh` y `02-install.sh` al directorio personal del nuevo usuario + +Al finalizar este script, inicia sesión con el usuario recién creado y ejecuta `01-setup-user.sh`. + +--- + +## 01-setup-user.sh — Usuario operador + +Ejecutar como el **usuario operador** (no como root). Este script genera la clave SSH necesaria para clonar el repositorio privado. + +```bash +bash ~/01-setup-user.sh +``` + +### Qué hace + +- Detecta disponibilidad de IPv4 e IPv6 +- Genera un par de claves SSH `ed25519` +- Muestra la clave pública y el estado de IPv6 + +> **Envía la clave pública SSH y el estado de IPv6 a Simplified Privacy, y espera a que la clave sea autorizada antes de continuar.** + +--- + +## 02-install.sh — Usuario operador + +Ejecutar únicamente después de que Simplified Privacy haya autorizado tu clave SSH. + +```bash +bash ~/02-install.sh +``` + +### Qué hace + +- Clona el repositorio privado `operator-docker` +- Ejecuta: + +```bash +sudo bash install.sh +``` + +A partir de este punto, el instalador principal toma el control. + +**Lee el archivo `README.md` de `operator-docker` (disponible en inglés y español) para conocer el proceso completo de instalación y las instrucciones posteriores.** + +--- + +## Notas + +- Los scripts **deben** ejecutarse en el siguiente orden: `00` → `01` → `02` +- `00` debe ejecutarse como **root** +- `01` y `02` deben ejecutarse como el **usuario operador** +- **No** ejecutes `02` hasta que Simplified Privacy confirme que tu clave SSH ha sido autorizada \ No newline at end of file