-
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy path.env.example
More file actions
113 lines (105 loc) · 3.69 KB
/
.env.example
File metadata and controls
113 lines (105 loc) · 3.69 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# ============================================
# Coderic Relay - Configuración
# ============================================
#
# Copia este archivo a .env y ajusta los valores según tu entorno
# cp .env.example .env
#
# ============================================
# CONFIGURACIÓN BÁSICA
# ============================================
# Puerto del servidor Relay (default: 5000)
PORT=5000
# ID de instancia (útil para clustering, default: PID del proceso)
INSTANCE_ID=1
# ============================================
# REDIS (Opcional - Para escalabilidad horizontal)
# ============================================
# Redis se usa como adapter de Socket.io para sincronizar mensajes
# entre múltiples instancias de Relay.
#
# Si no configuras Redis, Relay funcionará en modo standalone.
# Para producción con múltiples instancias, Redis es recomendado.
#
# Ejemplos:
# - Local: redis://localhost:6379
# - Docker: redis://redis:6379
# - Redis Cloud: redis://user:password@host:port
#
REDIS_URL=redis://localhost:6379
# ============================================
# KAFKA (Opcional - Para eventos asíncronos)
# ============================================
# Kafka se usa para publicar eventos asíncronos que pueden ser
# consumidos por otros sistemas (microservicios, analytics, etc.)
#
# Si no configuras Kafka, los eventos no se publicarán.
# Kafka es útil para integración con otros sistemas.
#
# Ejemplos:
# - Local: localhost:9092
# - Docker: kafka:9092
# - Múltiples brokers: kafka1:9092,kafka2:9092,kafka3:9092
#
KAFKA_BROKERS=localhost:9092
# ============================================
# MONGODB PLUGIN (Opcional - Para persistencia)
# ============================================
# MongoDB es un plugin opcional que proporciona persistencia de:
# - Mensajes enviados a través de Relay
# - Conexiones de usuarios (conectados/desconectados)
# - Eventos del sistema
# - Logs de actividad
#
# Si no configuras MongoDB, Relay funcionará sin persistencia.
# MongoDB es útil para:
# - Auditoría de mensajes
# - Análisis histórico
# - Recuperación de mensajes
# - Reportes y estadísticas
#
# Ejemplos:
# - Local: mongodb://localhost:27017
# - Docker: mongodb://mongo:27017
# - MongoDB Atlas: mongodb+srv://user:password@cluster.mongodb.net/dbname
# - Con autenticación: mongodb://user:password@host:27017/dbname
#
MONGO_URL=mongodb://localhost:27017
# Nombre de la base de datos (default: relay)
MONGO_DB_NAME=relay
# Nombres de colecciones personalizadas (opcional)
# Si no se especifican, se usan los valores por defecto:
MONGO_COLLECTIONS_MESSAGES=messages
MONGO_COLLECTIONS_CONNECTIONS=connections
MONGO_COLLECTIONS_EVENTS=events
MONGO_COLLECTIONS_LOGS=logs
# ============================================
# NOTAS IMPORTANTES
# ============================================
#
# 1. Redis y Kafka son opcionales pero recomendados para producción
# 2. MongoDB es completamente opcional - Relay funciona sin él
# 3. Todas las configuraciones son opcionales excepto PORT
# 4. Para desarrollo local, puedes dejar las URLs por defecto
# 5. Para producción, configura todas las URLs según tu infraestructura
#
# ============================================
# EJEMPLOS DE CONFIGURACIÓN
# ============================================
#
# Desarrollo local (sin servicios externos):
# PORT=5000
# (Redis, Kafka y MongoDB no configurados)
#
# Desarrollo local (con Docker Compose):
# PORT=5000
# REDIS_URL=redis://redis:6379
# KAFKA_BROKERS=kafka:9092
# MONGO_URL=mongodb://mongo:27017
#
# Producción (con todos los servicios):
# PORT=5000
# REDIS_URL=redis://redis-cluster:6379
# KAFKA_BROKERS=kafka1:9092,kafka2:9092,kafka3:9092
# MONGO_URL=mongodb+srv://user:pass@cluster.mongodb.net/relay
#