Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/banredco/helpdesk/llms.txt

Use this file to discover all available pages before exploring further.

Antes de instalar Banred Helpdesk, verifique que el servidor cumple con todas las versiones mínimas y extensiones detalladas en esta página. Un entorno con dependencias faltantes o versiones incompatibles puede provocar errores de conexión, fallos en la importación de correos o comportamientos inesperados en la gestión de sesiones y adjuntos.

PHP

Versión mínima: PHP 8.0. Se recomienda PHP 8.2 o superior para recibir actualizaciones de seguridad activas. Las siguientes extensiones deben estar habilitadas en php.ini o como módulos del sistema:
ExtensiónPropósito
pdoCapa de abstracción de base de datos. Requerida por toda la capa de acceso a datos.
pdo_mysqlDriver PDO específico para MySQL/MariaDB. Usado en config/connection.php.
imapConexión a buzones de correo mediante protocolo IMAP para importación de tickets.
mbstringManejo de cadenas multibyte (UTF-8). Necesario para asuntos y cuerpos de correo en español.
opensslCifrado TLS/SSL para conexiones SMTP seguras y IMAP sobre SSL.
jsonCodificación y decodificación JSON. Usado en respuestas de API y configuración.
sessionGestión de sesiones de usuario. Requerida por config/auth.php (session_start()).
Para verificar rápidamente que las extensiones críticas están disponibles, ejecute:
php -m | grep -E 'pdo_mysql|imap|mbstring|openssl'
La salida esperada debe mostrar las cuatro extensiones listadas. Si alguna está ausente, instálela con el gestor de paquetes del sistema (por ejemplo apt install php8.2-imap php8.2-mysql en Ubuntu).

MySQL / MariaDB

MotorVersión mínima
MySQL5.7 o superior (recomendado: 8.0+)
MariaDB10.3 o superior (recomendado: 10.6+)
La base de datos debe crearse con el juego de caracteres utf8mb4 y la colación utf8mb4_unicode_ci para soportar correctamente caracteres especiales, emojis en cuerpos de tickets y direcciones de correo internacionales.

Composer

Versión 2.x de Composer. Banred Helpdesk tiene una única dependencia PHP declarada en composer.json:
{
    "require": {
        "google/apiclient": "^2.19"
    }
}
La librería google/apiclient proporciona el cliente oficial de la API de Google y es necesaria para la integración con Gmail API en la importación y envío de correos a través de buzones de Google Workspace.

Servidor web

ServidorVersión mínima
Apache2.4 o superior
Nginx1.18 o superior
En Apache, el módulo mod_rewrite debe estar habilitado y la directiva AllowOverride All debe estar activa para el directorio raíz de la aplicación, lo que permite el uso de URLs limpias. En Nginx, configure el bloque location con try_files apuntando al index.php como se indica en la guía de instalación.

Sistema operativo

Linux es el sistema operativo recomendado. Las distribuciones con soporte oficial son:
  • Ubuntu 20.04 LTS (Focal Fossa)
  • Ubuntu 22.04 LTS (Jammy Jellyfish)
Windows no está soportado oficialmente. Aunque es posible ejecutar la aplicación en entornos como XAMPP o Laragon para desarrollo local, no se recomienda ni se da soporte para despliegues en producción sobre Windows Server.

Almacenamiento

Se requieren al menos 1 GB de espacio libre en disco para el almacenamiento de archivos adjuntos de tickets. El volumen real dependerá del número de tickets, el tamaño promedio de los adjuntos y el tiempo de retención configurado. Se recomienda monitorear periódicamente el directorio data/ y planificar políticas de archivo o limpieza según el crecimiento observado.

Permisos de archivos

El usuario del servidor web (www-data en Debian/Ubuntu, apache en RHEL/CentOS) debe tener permisos de lectura y escritura sobre el directorio /var/www/helpdesk_ban/data/ y todos sus subdirectorios. Este directorio se utiliza para:
  • Almacenamiento de archivos adjuntos subidos por agentes y clientes.
  • El archivo de credenciales de la cuenta de servicio de Google Workspace (google-workspace.json).
Para aplicar los permisos correctos:
chown -R www-data:www-data /var/www/helpdesk_ban/data/
chmod -R 750 /var/www/helpdesk_ban/data/
La ruta del archivo de credenciales de Google Workspace está definida directamente en GmailService.php como /var/www/helpdesk_ban/data/private/google-workspace.json. Si despliegue la aplicación en una ruta diferente a /var/www/helpdesk_ban, deberá actualizar esa ruta en el código fuente. Asegúrese también de que el directorio data/private/ no sea accesible públicamente desde el servidor web.

Build docs developers (and LLMs) love