omarchy_setup/DOCUMENTACION.md

DOCUMENTACION.md - Referencia Técnica de Módulos

Este documento proporciona una descripción técnica detallada de cada script y módulo que forma parte del proyecto Omarchy Setup.

1. Script Principal: omarchy-setup.sh

Este es el script orquestador y el punto de entrada para el usuario.

• Función Principal: Proporcionar una interfaz de menú interactiva que permite al usuario seleccionar qué módulos de configuración desea ejecutar.
• Características Clave:
  • Menú Dinámico: Muestra una lista de todos los módulos disponibles, permitiendo al usuario elegir uno, varios ("Instalar Todo") o salir.
  • Gestión de sudo: Solicita la contraseña de sudo una vez y la mantiene activa en segundo plano para evitar que el usuario tenga que introducirla repetidamente.
  • Ejecución Modular: Llama a las funciones principales de los scripts ubicados en el directorio modules/.
  • Feedback Visual: Implementa un "spinner" (indicador de progreso) para las tareas que se ejecutan en segundo plano, mejorando la experiencia del usuario.
  • Registro (Logging): Guarda un registro detallado de toda la sesión de instalación en el directorio logs/, lo que facilita la depuración en caso de errores.
  • Verificación del Sistema: Comprueba que el script se está ejecutando en Arch Linux antes de proceder.

2. Módulos (modules/)

2.1. common.sh

Este script no es un módulo ejecutable desde el menú, sino una librería de funciones compartidas por todos los demás módulos.

• Función Principal: Centralizar el código común para evitar duplicaciones y mantener la consistencia.
• Funciones Proporcionadas:
  • Logs con Colores: Funciones como log_info, log_success, log_warning y log_error para mostrar mensajes con un formato estandarizado.
  • Gestión de Paquetes:
    • check_and_install_pkg: Verifica si un paquete ya está instalado desde los repositorios oficiales y, si no, lo instala con pacman.
    • ensure_aur_helper y aur_install_packages: Detectan un helper de AUR (como yay o paru), lo instalan si es necesario, y lo utilizan para instalar paquetes desde el Arch User Repository.
  • Copias de Seguridad: La función backup_file renombra un archivo existente (ej. .zshrc) a .zshrc.bak_FECHA antes de sobrescribirlo, para prevenir la pérdida de configuraciones del usuario.
  • Verificaciones: command_exists comprueba si un comando está disponible en el sistema.

2.2. apps.sh

Es uno de los módulos más extensos y se encarga de la instalación de un conjunto base de aplicaciones y herramientas.

• Función Principal: Instalar software esencial de diversas categorías.
• Software Instalado:
  • Base del Sistema: git, curl, htop, btop, stow, gnome-keyring, openssh, etc.
  • Desarrollo: python, pip, nodejs, npm, arduino-cli. También instala nvm (Node Version Manager) y Homebrew para una gestión de paquetes más flexible.
  • Multimedia: VLC (y sus codecs), Audacity, Inkscape, yt-dlp para descargar vídeos.
  • Red: FileZilla, Telegram, speedtest-cli.
  • AUR: Visual Studio Code, Cursor, Keyd, Fragments, Logiops, TeamViewer, Antigravity.
  • Drivers para Intel Iris Xe: Instala todos los paquetes necesarios para el correcto funcionamiento de los gráficos integrados de Intel, incluyendo mesa, vulkan-intel, y los drivers para la aceleración de vídeo por hardware (VA-API).
• Configuraciones Adicionales:
  • Habilita y configura servicios del sistema como gnome-keyring-daemon (para gestión de contraseñas y claves SSH), keyd y logiops (para teclados y ratones avanzados), teamviewer y tlp (para la gestión avanzada de energía y optimización de la batería).

2.3. zsh-config.sh

Este módulo personaliza la experiencia del shell del usuario.

• Función Principal: Configurar Zsh como el shell principal con una apariencia y funcionalidad mejoradas.
• Acciones Realizadas:
  • Instalación: Instala zsh, zsh-completions y otras utilidades.
  • Oh My Zsh: Instala el framework "Oh My Zsh" para la gestión de plugins.
  • Plugins: Añade plugins populares como zsh-autosuggestions (sugiere comandos mientras escribes) y zsh-syntax-highlighting (colorea la sintaxis de los comandos).
  • Oh My Posh: Instala esta herramienta para crear un prompt de terminal altamente personalizable y descarga un tema predefinido (Catppuccin Frappe).
  • .zshrc: Reemplaza el ~/.zshrc del usuario por una versión pre-configurada que integra todas estas herramientas y añade alias y funciones útiles, incluyendo una función zsh_help que muestra una lista de todos los comandos personalizados.
  • Shell por Defecto: Cambia el shell de inicio de sesión del usuario a Zsh.

2.4. docker.sh

Configura un entorno de desarrollo basado en contenedores.

• Función Principal: Instalar y configurar Docker Engine y Docker Compose.
• Acciones Realizadas:
  • Instalación: Instala los paquetes docker y docker-compose.
  • Servicio: Habilita e inicia el servicio (daemon) de Docker para que se ejecute automáticamente al iniciar el sistema.
  • Permisos: Agrega el usuario actual al grupo docker, permitiéndole ejecutar comandos de Docker sin necesidad de sudo.
  • Portainer (Opcional): Pregunta al usuario si desea instalar Portainer, una interfaz gráfica web para gestionar contenedores, imágenes y volúmenes de Docker.

2.5. disk-format.sh

Añade soporte para sistemas de archivos comunes.

• Función Principal: Instalar las herramientas necesarias para interactuar con particiones y discos formateados en sistemas de archivos no nativos de Linux.
• Soporte Añadido:
  • ntfs-3g: Para leer y escribir en particiones NTFS (Windows).
  • exfatprogs: Para particiones exFAT, comunes en tarjetas SD y unidades USB.
  • e2fsprogs: Herramientas para el sistema de archivos nativo de Linux (ext4).

2.6. hyprland-config.sh

Configura un entorno de escritorio basado en el gestor de ventanas Hyprland.

• Función Principal: Instalar Hyprland y un conjunto de aplicaciones y configuraciones para tener un entorno de "tiling window manager" funcional y estético.
• Software Adicional: Instala componentes como waybar (barra de estado), wofi (lanzador de aplicaciones), swaylock (bloqueo de pantalla), y kitty (emulador de terminal).
• Configuración: Despliega una estructura de archivos de configuración predefinida para todos estos componentes.

2.7. icon_manager.sh

Permite personalizar la apariencia del sistema.

• Función Principal: Instalar y aplicar diferentes temas de iconos.
• Temas Disponibles: Ofrece una selección de temas populares como Papirus y Tela, instalándolos desde los repositorios de Arch o AUR.
• Aplicación: Utiliza gsettings para cambiar el tema de iconos activo en el entorno de escritorio.

2.8. mouse_cursor.sh

Mejora la apariencia del cursor del ratón.

• Función Principal: Instalar y configurar el tema de cursores Bibata.
• Acciones Realizadas: Descarga e instala el tema, y luego lo establece como el predeterminado para las aplicaciones GTK y el servidor gráfico X11.

2.9. printer.sh

Configura el sistema para poder utilizar impresoras.

• Función Principal: Instalar el sistema de impresión CUPS y los drivers necesarios.
• Acciones Realizadas:
  • CUPS: Instala el servidor de impresión CUPS y sus filtros.
  • Drivers: Instala drivers genéricos y específicos para impresoras Epson.
  • Servicios: Habilita los servicios de cups y avahi (para la detección de impresoras en red).
  • Permisos: Añade al usuario al grupo lp para permitirle administrar impresoras.

2.10. ssh-keyring.sh

Mejora la gestión de claves SSH.

• Función Principal: Sincronizar las claves SSH del usuario con el agente de GNOME Keyring.
• Funcionamiento:
  1. Verifica que el agente de gnome-keyring esté en ejecución.
  2. Busca todas las claves SSH privadas en el directorio ~/.ssh/.
  3. Utiliza ssh-add para añadir cada clave al agente. La primera vez que se use cada clave, GNOME Keyring pedirá la contraseña y la almacenará de forma segura. En usos posteriores, la desbloqueará automáticamente.
  • Importancia: Evita tener que escribir la contraseña de la clave SSH cada vez que se establece una conexión.

2.11. zerotier.sh

Instala una herramienta de VPN.

• Función Principal: Instalar y configurar el cliente de la VPN ZeroTier.
• Acciones Realizadas:
  • Instalación: Instala el paquete zerotier-one.
  • Servicio: Habilita e inicia el servicio de ZeroTier.
  • Unirse a Red (Opcional): Pregunta al usuario si desea unirse a una red de ZeroTier y, en caso afirmativo, le pide el ID de la red.