Instalar la aplicación en tus propios servidores

Esta página está dirigida al administrador técnico que instala MyZapp en sus propios servidores (instalación llamada «on-premise»). Una instancia alojada por el editor no tiene nada que instalar.

La instalación se basa en Docker: la aplicación y su base de datos PostgreSQL funcionan cada una en un contenedor, y todos los datos residen en dos volúmenes. No hay nada que compilar.

Lo que recibes

la imagen Docker de la aplicación, en un archivo .tar o para descargar desde un registro privado;
el archivo de orquestación docker-compose.onprem-client.yml;
la plantilla de configuración .env.template;
el script generate-secrets.sh, que crea las contraseñas de la base de datos;
el script init-condition-sql-role.sql, montado por el archivo de orquestación;
una carpeta views-override/ vacía.

Requisitos: Docker Engine (o Docker Desktop) con Docker Compose v2, al menos 2 GB de memoria y 10 GB de disco.

Instalar

Si la imagen se entrega en un archivo, cárgala: docker load -i seguido del nombre del archivo .tar.
Copia .env.template como .env y rellena al menos WEBBASE_IMAGE (la imagen que se va a usar) y APP_PORT (el puerto de la aplicación, 8080 por defecto).
Ejecuta ./generate-secrets.sh. Crea la carpeta secrets/ con dos contraseñas aleatorias para PostgreSQL. Estas contraseñas nunca figuran en .env; sin ellas, Docker Compose se niega a arrancar.
Arranca: docker compose -f docker-compose.onprem-client.yml up -d.
Abre la aplicación en el navegador, en la dirección del servidor y en el puerto elegido: aparece el asistente de configuración.

El asistente de configuración

El asistente solo aparece una vez, en una instancia nueva. Se muestra en el idioma del navegador cuando está disponible (español, francés o inglés), si no en francés; los enlaces de la parte superior de la página cambian de idioma en cualquier momento, y la elección vale para los pasos siguientes. Tiene cuatro pasos.

Base de datos (Conexión PostgreSQL): Host, Puerto, Base de datos, Usuario, Contraseña y Cifrado de la conexión. Con el archivo de orquestación entregado, el host de la base es webbase-postgres y la contraseña se deja vacía: la aplicación lee la de la carpeta secrets/. Probar conexión comprueba los valores antes de continuar.
Cuenta de administrador inicial: Nombre para mostrar, Dirección de correo y Contraseña del primer administrador.
Claves de seguridad: la clave de firma de los tokens de API, la clave de cifrado de los datos y la clave de cifrado de la doble autenticación se generan al azar. Exportar las descarga: guárdalas en un lugar seguro, no se pueden recuperar después de la configuración. Regenerar genera otras nuevas.
Resumen de configuración: introduce la Dirección pública de la instancia, en https://, la que abrirán los usuarios. Sirve para construir los enlaces enviados por correo. Marca si hace falta Instalar datos de demostración del catálogo de servicios y después Aplicar e iniciar.

La aplicación ejecuta sus migraciones, crea la cuenta de administrador y se reinicia sola: espera unos segundos antes de abrir la página de inicio de sesión. El archivo de orquestación entregado la vuelve a arrancar automáticamente.

Pasar a HTTPS

La aplicación solo se admite en HTTPS: fuera de un puesto de pruebas, sus cookies de sesión solo circulan por una conexión cifrada, y una conexión en HTTP no prospera. Coloca delante un proxy inverso (nginx, Traefik…) que lleve el certificado y transmita las peticiones al puerto de la aplicación.

El proxy debe transmitir las cabeceras X-Forwarded-For y X-Forwarded-Proto. Por defecto, la aplicación solo las cree si vienen de la propia máquina o de una red privada. Para creer solo al proxy, rellena TRUSTED_PROXIES (su dirección vista desde el contenedor) o TRUSTED_NETWORKS (su red) en .env.
El puerto de la aplicación solo debe ser accesible para el proxy: ciérralo en el cortafuegos o publícalo solo en la interfaz local.

Comprobar la instalación

La dirección /health de la instancia responde Healthy cuando la aplicación y su base de datos funcionan.
La pantalla Estado de la instancia muestra la versión, la base de datos, el espacio en disco y los módulos activados (ver «Supervisar la instancia»).
Activa después la licencia de la instancia (ver «Gestionar las licencias de la instancia») e importa la documentación entregada con la versión (ver «Actualizar la documentación»).

La herramienta de administración de la base

pgAdmin se entrega, pero no arranca por defecto. Para usarlo, rellena PGADMIN_EMAIL y PGADMIN_PASSWORD en .env y arranca con la opción --profile admin. Escucha en el puerto PGADMIN_PORT (5050 por defecto). Detenlo cuando ya no lo necesites.

Ver también

«Actualizar y hacer copias de seguridad de la aplicación»: copia de seguridad, restauración, cambio de versión y vuelta atrás.
«Cargar los datos de demostración»: llenar una instancia de pruebas.
«Cambiar la conexión a la base de datos»: modificar el acceso a PostgreSQL después de la instalación.