Saltar al contenido

Instalación rápida

Instala KumoYami en un servidor Linux con un solo comando.

El instalador prepara todo en un servidor o VPS con Linux: instala Docker si falta, inicia sesión en el registro privado con tu licencia, descarga los archivos de KumoYami, configura HTTPS con Caddy si le das un dominio, arranca la web y te muestra el código para la primera configuración.

ARM: próximamente

La imagen de KumoYami todavía es solo para procesadores x86_64 (Intel y AMD). La versión para ARM (arm64: Raspberry Pi, Mac con Apple Silicon, VPS y NAS con ARM) llegará en una próxima versión; esta guía se actualizará entonces.

Antes de empezar

  • Un servidor Linux (Debian, Ubuntu, Rocky, Alma…) con acceso como root o sudo, 1 GB de RAM como mínimo y 5 GB libres en disco.
  • El identificador (lic_…) y la clave (KY1.…) de tu licencia, del correo de compra.
  • Si quieres HTTPS desde el principio: un dominio (por ejemplo nube.example.com) con un registro A hacia la IP del servidor, y los puertos 80 y 443 libres y abiertos en el cortafuegos.

Instalar

Ejecuta el instalador

Conéctate al servidor por SSH y ejecuta:

curl -fsSL https://kumoyami.com/install.sh | sudo bash

Responde a sus preguntas

  • Docker: si no está instalado, pregunta si lo instala (con el script oficial de get.docker.com).
  • Licencia: el identificador lic_… y la clave KY1.…. La clave no se muestra al escribirla.
  • Dominio: escríbelo para tener HTTPS automático con Caddy, o déjalo vacío para omitirlo.
  • Email para Let's Encrypt: opcional.

Apunta el código de configuración

Al terminar, el instalador muestra un recuadro con el código de configuración inicial y la dirección del panel. Abre https://tu-dominio/admin, escribe el código y sigue el asistente.

Si no has dado un dominio, KumoYami solo es accesible desde el propio servidor. Para entrar al panel desde tu ordenador, abre un túnel SSH y visita http://localhost:4890/admin:

ssh -L 4890:127.0.0.1:4890 root@IP-DEL-SERVIDOR

Cuando quieras poner el dominio, vuelve a ejecutar el instalador con --domain o usa tu propio proxy inverso.

Qué hace, paso a paso

  1. Comprueba que el sistema es Linux en x86_64 o aarch64, que se ejecuta como root y que hay memoria y disco suficientes (avisa por debajo de 1 GB de RAM o de 5 GB libres).
  2. Instala Docker y el plugin docker compose si faltan, y arranca el servicio.
  3. Inicia sesión en registry.kumoyami.com con tu licencia (docker login). Si ya había una sesión, te pregunta si mantenerla.
  4. Crea la carpeta de instalación, por defecto /opt/kumoyami, con:
    • docker-compose.yml, descargado de kumoyami.com/install/docker-compose.yml.
    • .env, creado a partir de kumoyami.com/install/env.example (solo la primera vez; luego se conserva).
    • datos/, donde KumoYami guarda su configuración, propiedad del usuario del contenedor (uid 1000).
  5. Con dominio: comprueba que los puertos 80 y 443 están libres y que el DNS apunta al servidor, y escribe un Caddyfile y un docker-compose.override.yml con Caddy.
  6. Descarga la imagen, arranca los contenedores y espera hasta 2 minutos a que aparezca el código de configuración.

Puedes ejecutarlo de nuevo cuando quieras: actualiza el docker-compose.yml (guardando una copia del anterior como docker-compose.yml.bak-FECHA), conserva el .env y los datos, y vuelve a descargar y arrancar los contenedores.

Opciones

Con curl | bash, las opciones van después de bash -s --:

curl -fsSL https://kumoyami.com/install.sh | sudo bash -s -- --domain nube.example.com --email tu@example.com
OpciónQué hace
--domain DOMINIOActiva HTTPS automático con Caddy para ese dominio.
--email EMAILEmail de contacto para Let's Encrypt (opcional).
--dir RUTACarpeta de instalación (por defecto /opt/kumoyami).
--no-caddyNo configura Caddy, y lo desactiva si una ejecución anterior lo activó.
--keep-composeConserva el docker-compose.yml actual en vez de actualizarlo.
--unattendedSin preguntas: los datos de la licencia salen de las variables de entorno.
-h, --helpMuestra la ayuda.

Variables de entorno

VariableQué hace
KUMOYAMI_LICENSE_IDIdentificador de la licencia (lic_ y 12 caracteres hexadecimales).
KUMOYAMI_LICENSE_KEYClave de la licencia (empieza por KY1.).
KUMOYAMI_DIRIgual que --dir.
KUMOYAMI_DOMAINIgual que --domain.
KUMOYAMI_EMAILIgual que --email.
KUMOYAMI_INSTALL_DOCKERyes: instala Docker sin preguntar. no: no lo instala nunca.

Con sudo, las variables van después de sudo (las que tengas exportadas no pasan a través de él). Por ejemplo, una instalación sin preguntas:

curl -fsSL https://kumoyami.com/install.sh | sudo KUMOYAMI_LICENSE_ID=lic_xxxxxxxxxxxx \
  KUMOYAMI_LICENSE_KEY='KY1.…' bash -s -- --unattended --domain nube.example.com

Con --unattended hacen falta el identificador y la clave, salvo que el servidor ya tenga una sesión iniciada en el registro.

Comandos útiles

En la carpeta de instalación (cd /opt/kumoyami):

docker compose logs -f web                    # ver los registros (Ctrl+C para salir)
docker compose pull && docker compose up -d   # actualizar
docker compose logs web | grep -i código      # volver a ver el código de configuración

La configuración está en /opt/kumoyami/.env y los datos en /opt/kumoyami/datos.