Estructura inicial funcional con documentación en el README.md de la FastAPI

This commit is contained in:
2026-09-25 11:20:50 -03:00
parent edc71742fa
commit 774e227642
2710 changed files with 1012769 additions and 0 deletions

86
.env.example Normal file
View File

@@ -0,0 +1,86 @@
# =====================================================================
# Copiar a .env y completar: cp .env.example .env && chmod 600 .env
# Con Docker, docker-compose.yml fija STORAGE_TYPE, STORAGE_ROOT,
# DATABASE_URL y LOG_FILE: lo que pongas acá para esas cuatro se ignora.
# =====================================================================
# ===================== DOCKER (solo docker-compose.yml) =====================
# Carpeta del servidor con los archivos: la MISMA que fs.url de FSCrawler.
# Se monta en el contenedor como /datos, en solo lectura.
ARCHIVOS_DIR=/srv/archivos_prueba
# Dónde escucha la API en este servidor (el firewall limita quién entra).
# En desarrollo local: API_BIND=127.0.0.1 y API_PORT=8080
API_BIND=0.0.0.0
API_PORT=8000
# IP del Apache (.10), para registrar la IP real del usuario
FORWARDED_ALLOW_IPS=0.0.0.999
# Usuario con el que corre el contenedor (tiene que poder leer ARCHIVOS_DIR). Ver: id -u / id -g
APP_UID=1000
APP_GID=1000
# ===================== ALMACENAMIENTO (sin Docker) =====================
# local = carpeta del servidor Linux (disco propio o NAS montado por NFS)
# smb = solo si los archivos quedan en un recurso compartido Samba/NAS sin montar
STORAGE_TYPE=local
# La MISMA carpeta que recorre FSCrawler (fs.url)
STORAGE_ROOT=/srv/archivos_prueba
# --- Solo si STORAGE_TYPE=smb ---
# SMB_SERVER=
# SMB_SHARE=
# SMB_BASE_PATH=
# SMB_USERNAME=
# SMB_PASSWORD=
# SMB_ENCRYPT=true
# ===================== ELASTICSEARCH (lo alimenta FSCrawler) =====================
# Sin Docker: https://localhost:9200
# Con Docker (ES en el servidor): https://IP_DEL_SERVIDOR:9200 (dentro del contenedor, localhost es el contenedor)
# Desarrollo con --profile dev: http://elasticsearch:9200
ES_URL=https://0.0.0.0:9200
# FSCrawler 3.0 crea "<name>_docs": con name "archivos", el índice es archivos_docs
ES_INDEX=archivos_docs
# Usuario y clave, o ES_API_KEY (con permiso de solo lectura sobre el índice).
# En desarrollo con --profile dev: dejar vacíos (no tiene seguridad)
ES_USERNAME=api_archivos
ES_PASSWORD=
# ES_API_KEY=
# CA de Elasticsearch 8 (HTTPS).
# Sin Docker: /etc/elasticsearch/certs/http_ca.crt
# Con Docker: /certs/http_ca.crt (copiar el archivo a ./certs del proyecto)
# En desarrollo con --profile dev: vacío y ES_VERIFY_TLS=false
ES_CA_CERT=/certs/http_ca.crt
ES_VERIFY_TLS=true
ES_TIMEOUT=10
# Carpetas que la API NUNCA devuelve aunque estén indexadas (relativas a la raíz,
# respetando mayúsculas). Excluirlas también en FSCrawler (fs.excludes).
EXCLUDE_FOLDERS=
# ===================== BASE DE DATOS (sin Docker) =====================
# Solo guarda los logs de búsquedas y descargas. SQLite alcanza; PostgreSQL si prefieren.
DATABASE_URL=sqlite:///./api_archivos.db
# DATABASE_URL=postgresql+psycopg://usuario:clave@localhost:5432/archivos
LOG_FILE=logs/api_archivos.log
# ===================== SEGURIDAD =====================
# Secreto compartido con el sistema Admin (.10) para firmar los tokens (JWT).
# Generalo con: python -c "import secrets; print(secrets.token_urlsafe(48))"
JWT_SECRET=cambiar-este-secreto
# Secreto distinto para firmar los enlaces de descarga
DOWNLOAD_SECRET=cambiar-este-otro-secreto
# Minutos que dura un enlace de descarga
DOWNLOAD_LINK_TTL_MINUTES=30
# Roles que pueden buscar/descargar archivos
ALLOWED_ROLES=admin,data
# ===================== URLS / DESCARGAS =====================
# URL con la que el navegador llega a la API (a través del Apache de la .10).
# Para probar en local: http://127.0.0.1:8080 (tiene que coincidir con el puerto real)
PUBLIC_BASE_URL=https://admin.midominio.com/api
# direct = FastAPI entrega el archivo (simple; alcanza para uso normal)
# nginx = Nginx entrega el archivo (más eficiente con archivos grandes; ver deploy/nginx.conf)
DOWNLOAD_MODE=direct
NGINX_INTERNAL_PREFIX=/protegido/
CORS_ORIGINS=https://admin.midominio.com