Saltar al contenido

Instalación rápida

Instala KumoYami en un servidor Linux con un solo comando.

El instalador prepara todo en un servidor, un VPS o un equipo con Linux, en x86_64 o arm64 (también una Raspberry Pi con sistema de 64 bits). Instala Docker si falta, descarga KumoYami, monta tus carpetas, detecta la GPU para convertir vídeo y deja KumoYami accesible desde fuera de casa. Termina con las direcciones y la contraseña del panel.

La imagen es pública: se descarga sin iniciar sesión. La licencia se activa en el panel de KumoYami (Licencia).

Compatible con ARM

Desde la versión 0.1.3, la imagen de KumoYami es multiplataforma (amd64 y arm64): Docker descarga sola la variante de tu equipo, sin cambiar nada en el docker-compose.yml. Hace falta un sistema de 64 bits; los ARM de 32 bits no sirven.

Antes de empezar

  • Un equipo 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. Los pide el panel, no el instalador.
  • Para entrar desde fuera, una de estas tres cosas (el instalador te pregunta cuál):
    • un dominio con su registro A hacia la IP del servidor y los puertos 80 y 443 abiertos;
    • una cuenta de Cloudflare con tu dominio, si no puedes abrir puertos (por ejemplo, con CGNAT);
    • una cuenta de Tailscale, si solo vas a entrar tú desde tus dispositivos.

Instalar

Ejecuta el instalador

Conéctate al equipo por SSH y ejecuta:

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

Responde a sus preguntas

Se maneja con las flechas, la barra espaciadora para marcar y Intro para confirmar. Son seis pasos:

  1. Sistema: comprueba el equipo y, si falta Docker, pregunta si lo instala (con el script oficial).

  2. Licencia: no pregunta nada. Te recuerda que la licencia se activa después, en el panel.

  3. Carpetas: dónde guarda KumoYami sus datos y qué carpetas con tus archivos monta. Se montan en solo lectura; marca las que KumoYami pueda modificar (por ejemplo, las de subidas).

  4. Ajustes: el puerto local (4890), la zona horaria y la GPU, si la hay, para convertir vídeo.

  5. Acceso desde fuera de casa:

    • Dominio propio con HTTPS: Caddy pide los certificados de Let's Encrypt. Necesita los puertos 80 y 443.
    • Cloudflare Tunnel: sin abrir puertos. Pega el token del túnel y el instalador te dice qué poner en Cloudflare.
    • Tailscale: acceso privado para tus dispositivos, con Funnel opcional para abrirlo a Internet.
    • Ninguno: solo desde este equipo, o detrás de tu propio proxy inverso.

    Te pide un dominio para Archivos y, si usas la Biblioteca, otro para ella (por defecto app. delante del tuyo).

  6. Resumen: revisa las respuestas antes de aplicar nada.

Guarda la contraseña

Al terminar, el instalador muestra las direcciones y la contraseña del panel, solo esa vez. Abre https://tu-dominio/admin y entra con ella. La primera vez, el panel abre la página Licencia: pega tu clave KY1.… y listo (cómo funciona la licencia).

Sin acceso desde fuera, KumoYami solo es accesible desde el propio servidor. Para entrar al panel desde tu ordenador, abre un túnel SSH con los tres puertos y visita http://localhost:4890/admin (la Biblioteca en :4891 y Archivos en :4892):

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

Qué deja en el servidor

En la carpeta de instalación, por defecto /opt/kumoyami:

  • docker-compose.yml: el de KumoYami, descargado de kumoyami.com/install/docker-compose.yml.
  • docker-compose.override.yml: lo tuyo (carpetas, GPU, Caddy, Cloudflare Tunnel o Tailscale). Docker Compose lo une solo al otro, así que docker compose funciona igual.
  • .env: tus variables, incluida la contraseña del panel (ADMIN_PASSWORD). Solo lo puede leer root.
  • kumoyami-instalador.conf: tus respuestas, que serán las respuestas por defecto la próxima vez.
  • datos/: la configuración de KumoYami, propiedad del usuario del contenedor (uid 1000).

Antes de cambiar un archivo guarda una copia (.bak-FECHA). Un valor que ya está en el .env solo cambia si lo cambias tú en las preguntas.

Actualizar, cambiar o desinstalar

Vuelve a ejecutar el instalador. En una instalación que ya existe, muestra un menú: Actualizar, Cambiar la configuración, Reparar o Desinstalar. También directamente:

curl -fsSL https://kumoyami.com/install.sh | sudo bash -s -- update      # última versión de tu licencia
curl -fsSL https://kumoyami.com/install.sh | sudo bash -s -- repair      # vuelve a descargar y recrea los contenedores
curl -fsSL https://kumoyami.com/install.sh | sudo bash -s -- uninstall   # conserva tus datos

Desinstalar conserva los datos. Para borrarlos también, confírmalo dos veces (sin terminal, --purge --confirm-purge); tus carpetas montadas no se tocan nunca.

Sin preguntas

Sin terminal (en un script) o con --yes, el instalador no pregunta: usa las opciones, las variables y lo que ya estaba configurado, y se para con un mensaje claro si falta algo. Con sudo, las variables van después de sudo:

curl -fsSL https://kumoyami.com/install.sh | sudo KUMOYAMI_TUNNEL_TOKEN='eyJ…' bash -s -- --yes \
  --access cloudflare --domain nube.example.com --media /srv/fotos

--dry-run lo simula todo: enseña cada archivo y cada orden sin cambiar nada.

OpciónQué hace
--access MODOcaddy, cloudflare, tailscale o none.
--domain DOMINIODominio de Archivos. Sin --access, activa Caddy.
--library-domain DOMINIODominio de la Biblioteca (por defecto app.<dominio>). --no-library: sin él.
--email EMAILEmail para Let's Encrypt (opcional).
--funnelCon Tailscale, abre la web a Internet con Funnel.
--media RUTA[:rw]Carpeta que montar en /data/<nombre>, en solo lectura salvo :rw. Repetible.
--data-dir RUTACarpeta de datos (por defecto <dir>/datos).
--dir RUTACarpeta de instalación (por defecto /opt/kumoyami).
--port PUERTOPuerto local (por defecto 4890, solo en 127.0.0.1).
--timezone ZONAZona horaria, por ejemplo Europe/Madrid.
--gpu MODOnone, auto, dri (Intel o AMD), rpi (Raspberry Pi 4) o nvidia.
--keep-composeConserva tu docker-compose.yml en vez de actualizarlo.
--no-admin-passwordNo genera la contraseña: el asistente pedirá el código de los registros.
--yes, --dry-run, --no-color, -hSin preguntas, simulación, sin colores, ayuda.
VariableQué hace
KUMOYAMI_LICENSE_ID, KUMOYAMI_LICENSE_KEYOpcional: tu licencia. Con ellas, el instalador inicia sesión en el registro; si falla, sigue igual.
KUMOYAMI_TUNNEL_TOKENToken del túnel de Cloudflare.
KUMOYAMI_TS_AUTHKEYAuth key reutilizable de Tailscale.
KUMOYAMI_INSTALL_DOCKERyes: instala Docker sin preguntar. no: no lo instala nunca.

Cada opción tiene también su variable (KUMOYAMI_DOMAIN, KUMOYAMI_MEDIA, KUMOYAMI_GPU…): están todas en --help.

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 a mano

Todas las marcas y logotipos pertenecen a sus respectivos propietarios. Su uso solo indica compatibilidad, no patrocinio ni asociación. El logotipo de Synology es una marca de Synology Inc.; Google Drive, Google Cast y Android son marcas de Google LLC, y el robot de Android es obra de Google, compartida con la licencia Creative Commons Reconocimiento 3.0. Microsoft, Windows y OneDrive son marcas de Microsoft; Amazon S3, de Amazon.com, Inc. o sus filiales; Apple, AirPlay, macOS e iPhone, de Apple Inc.; Raspberry Pi, de Raspberry Pi Ltd; Ubuntu, de Canonical Ltd.; Debian, de Software in the Public Interest, Inc.; Linux, de Linus Torvalds. Este producto usa la API de TMDB, pero TMDB no lo respalda ni certifica.