Actualizar la configuración del README.md, agregar archivo .env.example y mejorar el .gitignore
This commit is contained in:
96
README.md
96
README.md
@@ -41,22 +41,41 @@ git clone <tu-repositorio>
|
||||
cd onedrive
|
||||
```
|
||||
|
||||
2. Configura las variables de entorno en `docker-compose.yml`:
|
||||
2. Copia el archivo de configuración de ejemplo:
|
||||
|
||||
```yaml
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
3. Edita el archivo `.env` con tus credenciales:
|
||||
|
||||
```bash
|
||||
# Linux/Mac
|
||||
nano .env
|
||||
|
||||
# Windows
|
||||
notepad .env
|
||||
```
|
||||
|
||||
4. Rellena todas las variables requeridas:
|
||||
|
||||
```env
|
||||
E5_CLIENT_ID=tu_client_id
|
||||
E5_CLIENT_SECRET=tu_client_secret
|
||||
E5_REFRESH_TOKEN=tu_refresh_token
|
||||
WEB_APP_PASSWORD=tu_password_segura
|
||||
E5_WEB_APP_PASSWORD=tu_e5_password
|
||||
CRON_PASSWORD=tu_cron_password
|
||||
CRON_REFRESH_TOKEN=tu_cron_refresh_token
|
||||
```
|
||||
|
||||
3. Inicia los servicios:
|
||||
5. Inicia los servicios:
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
4. Verifica el estado:
|
||||
6. Verifica el estado:
|
||||
|
||||
```bash
|
||||
docker-compose ps
|
||||
@@ -65,25 +84,35 @@ docker-compose logs -f
|
||||
|
||||
## ⚙️ Configuración
|
||||
|
||||
### Archivo `.env`
|
||||
|
||||
El archivo `.env` contiene todas las variables de entorno necesarias. **Nunca** debes:
|
||||
|
||||
- ❌ Subir `.env` a Git
|
||||
- ❌ Compartir `.env` públicamente
|
||||
- ❌ Guardar credenciales en el código
|
||||
|
||||
El archivo `.env.example` se incluye como referencia para documentar qué variables se necesitan.
|
||||
|
||||
### Variables de Entorno
|
||||
|
||||
#### Servicio `odengin`
|
||||
|
||||
| Variable | Descripción | Requerida |
|
||||
| --------------------- | ------------------------------- | --------- |
|
||||
| `E5_CLIENT_ID` | Client ID de Microsoft Azure | ✅ |
|
||||
| `E5_CLIENT_SECRET` | Client Secret de Azure | ✅ |
|
||||
| `E5_REFRESH_TOKEN` | Token de renovación | ✅ |
|
||||
| `WEB_APP_PASSWORD` | Contraseña de la aplicación web | ✅ |
|
||||
| `E5_WEB_APP_PASSWORD` | Contraseña adicional E5 | ✅ |
|
||||
| Variable | Descripción | Requerida | Variable de Entorno |
|
||||
| --------------------- | ------------------------------- | --------- | --------------------- |
|
||||
| `E5_CLIENT_ID` | Client ID de Microsoft Azure | ✅ | `E5_CLIENT_ID` |
|
||||
| `E5_CLIENT_SECRET` | Client Secret de Azure | ✅ | `E5_CLIENT_SECRET` |
|
||||
| `E5_REFRESH_TOKEN` | Token de renovación | ✅ | `E5_REFRESH_TOKEN` |
|
||||
| `WEB_APP_PASSWORD` | Contraseña de la aplicación web | ✅ | `WEB_APP_PASSWORD` |
|
||||
| `E5_WEB_APP_PASSWORD` | Contraseña adicional E5 | ✅ | `E5_WEB_APP_PASSWORD` |
|
||||
|
||||
#### Servicio `odcron`
|
||||
|
||||
| Variable | Descripción | Requerida |
|
||||
| --------------- | -------------------------------------------- | --------- |
|
||||
| `IP` | Dirección del motor (formato: `host:puerto`) | ✅ |
|
||||
| `PASSWORD` | Contraseña de autenticación | ✅ |
|
||||
| `REFRESH_TOKEN` | Token de renovación | ✅ |
|
||||
| Variable | Descripción | Requerida | Variable de Entorno |
|
||||
| ------------------- | -------------------------------------------- | --------- | -------------------- |
|
||||
| IP del motor | Dirección del motor (formato: `host:puerto`) | ✅ | `CRON_IP` |
|
||||
| Contraseña | Contraseña de autenticación | ✅ | `CRON_PASSWORD` |
|
||||
| Token de renovación | Token de renovación | ✅ | `CRON_REFRESH_TOKEN` |
|
||||
|
||||
### Puertos
|
||||
|
||||
@@ -170,12 +199,35 @@ docker exec -it odcron ping odengin
|
||||
|
||||
## 🛡️ Seguridad
|
||||
|
||||
> ⚠️ **Importante**:
|
||||
>
|
||||
> - Nunca subas credenciales al repositorio
|
||||
> - Usa variables de entorno o archivos `.env`
|
||||
> - Cambia las contraseñas por defecto
|
||||
> - Mantén las imágenes actualizadas
|
||||
### Gestión de Credenciales
|
||||
|
||||
✅ **HACER:**
|
||||
|
||||
- ✅ Usar archivo `.env` para variables sensibles
|
||||
- ✅ Incluir `.env` en `.gitignore`
|
||||
- ✅ Compartir solo `.env.example` con placeholders
|
||||
- ✅ Cambiar contraseñas por defecto
|
||||
- ✅ Restringir permisos del archivo `.env`: `chmod 600 .env`
|
||||
- ✅ Usar secretos de Docker/Kubernetes en producción
|
||||
|
||||
❌ **NO HACER:**
|
||||
|
||||
- ❌ Nunca subir `.env` a Git
|
||||
- ❌ No guardar credenciales en el código
|
||||
- ❌ No compartir `.env` por mensajes o email
|
||||
- ❌ No usar contraseñas débiles
|
||||
- ❌ No hacer commit accidental de `.env`
|
||||
|
||||
### Verificar antes de subir
|
||||
|
||||
```bash
|
||||
# Asegurate de que .env NO está en Git
|
||||
git status
|
||||
|
||||
# Si fue agregado accidentalmente:
|
||||
git rm --cached .env
|
||||
git commit --amend -m "Remove .env from repository"
|
||||
```
|
||||
|
||||
## 📝 Notas
|
||||
|
||||
|
||||
Reference in New Issue
Block a user