Instalación - Magento

Para empezar a utilizar DockRay en Magento, crea un proyecto en DockRay, copia su token y genera una clave privada de API. El token identifica el proyecto, mientras que la clave privada autentica tu instalación de Magento.

¿Todavía no tienes un proyecto? Lee la guía Crear una cuenta y el primer proyecto y vuelve después a esta documentación para instalar la integración.

Requisitos del sistema

La integración de DockRay es compatible con tiendas que utilizan Magento Open Source o Adobe Commerce 2.4.4 o posterior, así como Mage-OS. Se requiere PHP 8.1 o una versión posterior.

El paquete se distribuye mediante Composer con el nombre dockcodes/dock-ray-magento. Antes de instalarlo, comprueba si la última versión está disponible en el canal de distribución correspondiente.

Instalar DockRay en Magento mediante Composer

Conéctate al servidor de la tienda y accede al directorio raíz de Magento. A continuación, ejecuta los siguientes comandos para instalar el paquete, activar el módulo y actualizar la configuración de la aplicación.

composer require dockcodes/dock-ray-magento
bin/magento module:enable DockCodes_DockRay
bin/magento setup:upgrade

# En producción, ejecuta también:


bin/magento setup:di:compile
bin/magento setup:static-content:deploy

Una vez finalizada la instalación, el módulo DockRay estará disponible en el panel de administración de Magento. En los entornos de producción, ejecuta los comandos siguiendo el procedimiento de despliegue de tu tienda.

Configurar el token del proyecto y la clave privada

Conecta tu instalación de Magento con el proyecto de DockRay que has creado. En el panel de administración, ve a Tiendas → Configuración → DockRay → Monitoring e introduce el token del proyecto y la clave privada.

Si prefieres no guardar la clave privada en la base de datos, puedes almacenar ambas credenciales en la configuración del entorno mediante los siguientes comandos:

bin/magento config:set --lock-env dockray/connection/token TU_TOKEN_DE_PROYECTO
bin/magento config:set --lock-env dockray/connection/private_key TU_CLAVE_PRIVADA

Sustituye TU_TOKEN_DE_PROYECTO por el token de tu proyecto y TU_CLAVE_PRIVADA por la clave de API que hayas generado. Al guardar los valores con la opción --lock-env, los campos correspondientes quedan bloqueados en el panel de administración y utilizan los valores almacenados en la configuración del entorno.

Comprobar la integración en el panel de administración de Magento

Después de guardar las credenciales, abre DockRay → Overview. En esta pantalla puedes consultar el estado de la conexión, las funciones disponibles del módulo y la información del último informe de vulnerabilidades. También puedes enviar un evento de prueba para comprobar que la integración funciona correctamente.

Para administrar la configuración de la integración, selecciona DockRay → Settings en el menú de administración de Magento. Overview permite consultar el estado de la integración, mientras que Settings da acceso a las opciones de configuración.

Verificación después de la instalación

Antes de activar la monitorización, comprueba que el token y la clave privada pertenecen al mismo proyecto de DockRay. Asegúrate también de que la clave privada no se haya incluido en el repositorio ni en código de la aplicación accesible públicamente.

A continuación, configura el entorno, define el alcance de los informes y envía un evento de prueba. Cuando hayas confirmado que la integración funciona correctamente, podrás activar la generación de informes para el tráfico de producción.

¿Qué hacer a continuación?

Después de la instalación, consulta la guía sobre la monitorización de vulnerabilidades de aplicaciones con DockRay para configurar las comprobaciones de vulnerabilidades conocidas y revisar los informes de los componentes de Magento.