Requisitos del Sistema
Hardware Recomendado
Hardware Recomendado
- CPU: 2+ núcleos - RAM: 8GB+ - Almacenamiento: 60GB+ de espacio libre
Software Requerido
Software Requerido
- Docker (última versión estable)
- Node.js (última versión LTS)
- Yarn o NPM (última versión estable)
- Nombre de dominio o IP fija (para despliegues externos)
Puertos Requeridos
Puertos Requeridos
- 3000: Kodus Web App
- 3001: API
- 3332: Webhooks
- 5672, 15672, 15692: RabbitMQ (AMQP, administración, métricas)
- 3101: MCP Manager (API, métricas)
- 5432: PostgreSQL - 27017: MongoDB
Se requiere acceso a internet si planeas conectarte a servicios Git en la nube (GitHub, GitLab, Bitbucket) o proveedores de LLM en la nube (OpenAI, Anthropic, etc.). Para herramientas Git auto-alojadas y LLMs on-premise dentro de tu red, el acceso externo a internet es opcional.
Configuración de Dominio (Opcional)
Si planeas integrar Kodus con proveedores Git en la nube (GitHub, GitLab o Bitbucket), necesitarás URLs públicas tanto para la aplicación web de Kodus como para su API. Esto permite que tu servidor reciba webhooks para el correcto funcionamiento de la Revisión de Código y garantiza el comportamiento correcto de la aplicación. Recomendamos configurar dos subdominios:- Uno para la Aplicación Web, por ejemplo,
kodus-web.tudominio.com. - Uno para la API, por ejemplo,
kodus-api.tudominio.com.
- Usar un subdominio dedicado para webhooks, por ejemplo,
kodus-webhooks.tudominio.com, o - Seguir usando el dominio de la API y enrutar
/github/webhook,/gitlab/webhook, etc. al servicio de webhooks en tu proxy inverso.
Nota: Si solo te conectas a herramientas Git auto-alojadas en tu red y no necesitas acceso público ni webhooks, podrías usar una configuración más simple, pero esta guía se centra en despliegues con acceso público.
Configuración
Editar el archivo de entorno
Edita Consulta Configuración de Variables de Entorno para instrucciones detalladas.
.env con tus valores usando tu editor de texto preferido.¡Éxito! 🎉
Una vez completado, los servicios de Kodus deberían estar ejecutándose en tu máquina.
Puedes verificar la instalación con el siguiente script:
Acceder a la interfaz web
Al acceder a la interfaz web por primera vez, necesitarás:
- Crear tu cuenta de administrador - Este será el primer usuario con acceso completo al sistema
- Configurar tu proveedor Git - Conecta GitHub, GitLab o Bitbucket siguiendo las instrucciones en pantalla
- Seleccionar repositorios para análisis - Elige qué repositorios de código revisará Kody
Para pasos detallados sobre el proceso de configuración inicial, consulta nuestra Guía de Inicio Rápido.
Configuración de variables de entorno
Usa esta sección para completar tu.env. Comienza con las URLs públicas, luego
configura las bases de datos y RabbitMQ, y finalmente agrega la configuración
específica de cada proveedor.
Configuración de espacio de nombres
Estas configuraciones definen las URLs públicas y el enlace de host utilizados por la aplicación web y la API. Si no usas MCP Manager, puedes omitir las entradas de MCP aquí y el bloque completo a continuación.Configuración del proveedor LLM
Configuración de base de datos
Usa contenedores locales para Postgres y MongoDB de forma predeterminada. Actualiza las credenciales para que cumplan con tus requisitos de seguridad.Configuración de RabbitMQ
RabbitMQ es obligatorio en la versión 2.0. Mantén la URI sincronizada con los valores a continuación.Configuración del proveedor Git
Elige y configura tu proveedor Git preferido. Puedes configurar uno o más proveedores; para la autenticación básica basada en token, solo necesitas la URL del webhook.Los webhooks son gestionados por un servicio separado (puerto 3332). Las URLs de tus webhooks deben llegar a ese servicio. Puedes usar un dominio dedicado para webhooks, o mantener el dominio de la API y enrutar las rutas
/.../webhook al servicio de webhooks en tu proxy inverso.
¿Usas OAuth de GitHub o GitLab? Consulta OAuth App de GitHub o OAuth App de GitLab. Para la configuración de GitHub App, consulta GitHub App.- Github
- GitLab
- Bitbucket
- Azure DevOps
Configuración del MCP Manager
Solo necesario si deseas usar MCP Manager.
Configuración de revisión de código AST
Solo necesario si deseas habilitar la revisión de código basada en AST.
Configuración de servicios externos (opcional)
Estos servicios son opcionales pero mejoran significativamente la calidad de la revisión de código de Kodus. Cada uno requiere crear una cuenta y generar una clave de API.E2B — Sandbox de ejecución de código
E2B — Sandbox de ejecución de código
E2B proporciona un sandbox seguro que Kodus usa para ejecutar y validar código durante las revisiones.
- Crea una cuenta en e2b.dev
- Genera una clave de API en tu panel de control
- Agrégala a tu
.env:
MorphLLM — Modelo de edición de código
MorphLLM — Modelo de edición de código
MorphLLM es un modelo especializado para la edición de código rápida y precisa. Kodus lo utiliza para aplicar sugerencias de revisión con mayor precisión.
- Crea una cuenta en morphllm.com
- Genera una clave de API en tu panel de control
- Agrégala a tu
.env:
¿Necesitas ayuda?
Programa una llamada con nuestro fundador para obtener ayuda con tu despliegue.
Obtén ayuda en nuestra comunidad
Únete a nuestra comunidad para obtener ayuda con tu despliegue.