Esta página se tradujo automáticamente. ¿Detectaste un error?Ayuda a mejorarla.
Skip to content

Configuración

Toda la configuración se realiza mediante variables de entorno. Cada variable tiene un valor predeterminado sensato, por lo que SnapOtter funciona de inmediato sin necesidad de establecer ninguna de ellas.

Variables de entorno

Servidor

VariablePredeterminadoDescripción
PORT1349Puerto en el que escucha el servidor.
RATE_LIMIT_PER_MIN1000Máximo de solicitudes por minuto por IP. Ponlo a 0 para desactivar la limitación de tasa.
CORS_ORIGIN(vacío)Orígenes permitidos para CORS separados por comas, o vacío para solo el mismo origen.
LOG_LEVELinfoVerbosidad del registro. Uno de: fatal, error, warn, info, debug, trace.
TRUST_PROXYloopback,linklocal,uniquelocalQué pares pueden establecer la IP del cliente mediante X-Forwarded-For. El valor predeterminado solo cree a un par de una red privada, así que un proxy inverso en una red de Docker o en una LAN sí es de confianza y la cabecera falsificada de un cliente público no. Pon true solo cuando delante haya un proxy bajo tu control en una dirección pública.

Autenticación

Los dos valores booleanos de abajo solo aceptan true y false. Cualquier otra cosa, ya sea 1, yes u on, no supera la validación y el servidor termina antes de ponerse a escuchar.

VariablePredeterminadoDescripción
AUTH_ENABLEDtrueExige un inicio de sesión. Ponlo a false para funcionar sin ninguna cuenta, lo que concede permisos de administrador a todas las solicitudes, así que resérvalo para una red de confianza.
DEFAULT_USERNAMEadminNombre de usuario de la cuenta de administrador inicial. Solo se usa en la primera ejecución.
DEFAULT_PASSWORDadminContraseña de la cuenta de administrador inicial. Cámbiala tras el primer inicio de sesión.
MAX_USERS0 (ilimitado)Número máximo de cuentas de usuario registradas. Ponlo a 0 para ilimitado.
SESSION_DURATION_HOURS168Duración de la sesión de inicio de sesión en horas (el valor predeterminado es 7 días).
SKIP_MUST_CHANGE_PASSWORDfalsePonlo a true para omitir el aviso obligatorio de cambio de contraseña en el primer inicio de sesión.

Almacenamiento

VariablePredeterminadoDescripción
STORAGE_MODElocallocal o s3. S3 y MinIO necesitan una licencia con la función s3_storage, además de las variables S3_* de abajo.
DATABASE_URLpostgres://snapotter:snapotter@localhost:5432/snapotterCadena de conexión de PostgreSQL. La pila de Compose la apunta a su servicio postgres; déjala sin establecer (junto con REDIS_URL) para obtener el modo embebido.
REDIS_URLredis://localhost:6379Cadena de conexión de Redis (usada para las colas de tareas de BullMQ). Compose la apunta a su servicio redis.
WORKSPACE_PATH./tmp/workspaceDirectorio para archivos temporales durante el procesamiento. Se limpia automáticamente. La imagen establece /tmp/workspace.
FILES_STORAGE_PATH./data/filesDirectorio para archivos de usuario persistentes (imágenes subidas, resultados guardados). La imagen establece /data/files.

Almacenamiento de objetos S3

Solo se leen cuando STORAGE_MODE=s3. Si falta alguna de las tres obligatorias, el arranque falla indicando el nombre de la variable que omitiste.

VariablePredeterminadoDescripción
S3_BUCKET(vacío)Bucket que contiene las subidas y las salidas. Obligatorio.
S3_ACCESS_KEY_ID(vacío)Clave de acceso. Obligatoria. En el contenedor puedes montarla en su lugar, mediante S3_ACCESS_KEY_ID_FILE.
S3_SECRET_ACCESS_KEY(vacío)Clave secreta. Obligatoria. Misma convención de archivo: S3_SECRET_ACCESS_KEY_FILE.
S3_REGIONus-east-1Región del bucket.
S3_ENDPOINT(vacío)Endpoint personalizado para MinIO, R2, Backblaze y otros almacenes compatibles con S3. Vacío significa AWS.
S3_FORCE_PATH_STYLEfalsePonlo a true para MinIO y para cualquier otro que espere endpoint/bucket/key en lugar del direccionamiento por host virtual.
S3_PREFIX(vacío)Prefijo de clave, para que un mismo bucket pueda alojar varias instancias.

Cifrado en reposo

VariablePredeterminadoDescripción
DATA_ENCRYPTION_KEY(vacío)64 caracteres hexadecimales (32 bytes). Cifra los ajustes sensibles almacenados en la base de datos. Cualquier cosa que no sean 64 caracteres hexadecimales se rechaza al arrancar.
DATA_ENCRYPTION_KEY_PREVIOUS(vacío)La clave que estás dejando atrás en una rotación, con el mismo formato. Establece ambas durante la rotación para que las filas existentes se sigan descifrando, y luego elimina esta.

Modo embebido

Ejecuta la imagen sin DATABASE_URL ni REDIS_URL y arrancará sus propios PostgreSQL 17 y Redis dentro del contenedor, enlazados a loopback, con todos los datos en el volumen /data. Esto restaura la experiencia de un solo comando docker run para el inicio rápido, el homelab y las actualizaciones desde la 1.x. Es una vía de conveniencia, no un despliegue de producción: para producción, ejecuta la pila de Compose de 3 contenedores con PostgreSQL y Redis separados. El modo embebido requiere ejecutar el contenedor como root y es incompatible con los tiempos de ejecución de UID arbitrario (OpenShift, Kubernetes runAsNonRoot); usa Compose en esos casos.

VariablePredeterminadoDescripción
EMBEDDEDautoSe activa automáticamente cuando tanto DATABASE_URL como REDIS_URL están sin establecer. Ponlo a 0 para desactivarlo (la app entonces falla rápido si no hay DATABASE_URL/REDIS_URL externo establecido, en lugar de arrancar silenciosamente una base de datos dentro del contenedor).
REDIS_MAXMEMORY512mbLímite de memoria para el Redis embebido (solo en modo embebido). Redúcelo en hosts con memoria limitada, como una Raspberry Pi.

Actualizar desde la 1.x: coloca tu antiguo snapotter.db en /data/snapotter.db dentro del volumen y el modo embebido lo importa al PostgreSQL embebido en el primer arranque. La importación se ejecuta una vez; los arranques posteriores la omiten.

Nota sobre telemetría: el modo embebido hereda el valor predeterminado de analítica de la imagen como cualquier otra configuración. La imagen publicada se distribuye con la analítica activada; compila con --build-arg SNAPOTTER_ANALYTICS=off, o usa la exclusión voluntaria de administrador dentro de la app, para desactivarla.

Límites de procesamiento

VariablePredeterminadoDescripción
MAX_UPLOAD_SIZE_MB0 (ilimitado)Tamaño máximo de archivo por subida en megabytes. Ponlo a 0 para ilimitado. La imagen publicada se distribuye con 0; una compilación desde el código fuente empieza en 100.
MAX_BATCH_SIZE0 (ilimitado)Número máximo de archivos en una sola solicitud por lotes. Ponlo a 0 para ilimitado. La imagen publicada se distribuye con 0; una compilación desde el código fuente empieza en 100.
CONCURRENT_JOBS0 (automático)Número de tareas por lotes que se ejecutan en paralelo. Ponlo a 0 para detectarlo automáticamente según los núcleos de CPU disponibles.
MAX_MEGAPIXELS0 (ilimitado)Resolución máxima de imagen permitida en megapíxeles. Ponlo a 0 para ilimitado.
MAX_WORKER_THREADS0 (automático)Máximo de hilos de trabajo para el procesamiento de imágenes. Ponlo a 0 para detectarlo automáticamente según los núcleos de CPU disponibles.
PROCESSING_TIMEOUT_S0 (sin límite)Tiempo máximo de procesamiento por solicitud en segundos. Ponlo a 0 para que no haya tiempo de espera.
MAX_PIPELINE_STEPS20Número máximo de pasos en una canalización. Ponlo a 0 para que no haya límite.
MAX_CANVAS_PIXELS0 (sin límite)Tamaño máximo del lienzo en píxeles para las imágenes de salida. Ponlo a 0 para que no haya límite.
MAX_SVG_SIZE_MB50El SVG más grande que se acepta antes de sanearlo, en megabytes. Aquí 0 se comporta de forma distinta que en las filas de alrededor. Elimina por completo el límite de tamaño previo al análisis en lugar de subirlo, así que deja esta variable con un valor.
MAX_PDF_PAGES0 (ilimitado)Número máximo de páginas de PDF para la conversión de PDF a imagen. Ponlo a 0 para ilimitado.

Limpieza

VariablePredeterminadoDescripción
FILE_MAX_AGE_HOURS72Cuánto tiempo se conservan los resultados de procesamiento no guardados (subidas en bruto y salidas de herramientas) antes de su eliminación automática. Los archivos que guardas explícitamente en la biblioteca de Archivos no se ven afectados y persisten hasta que los eliminas.
CLEANUP_INTERVAL_MINUTES60Con qué frecuencia se ejecuta la tarea de limpieza.

Apariencia

VariablePredeterminadoDescripción
DEFAULT_THEMElightTema predeterminado para las sesiones nuevas. light, dark o system.
DEFAULT_LOCALEenIdioma predeterminado de la interfaz.
DEFAULT_TOOL_VIEWsidebarDiseño de herramienta predeterminado. sidebar o fullscreen.

Permisos de Docker

VariablePredeterminadoDescripción
PUID999Ejecuta el proceso del contenedor con este UID. Ponlo para que coincida con tu usuario del host en los montajes de enlace (id -u).
PGID999Ejecuta el proceso del contenedor con este GID. Ponlo para que coincida con tu grupo del host en los montajes de enlace (id -g).

Ejemplo de Docker

yaml
services:
  SnapOtter:
    image: snapotter/snapotter:latest
    ports:
      - "1349:1349"
    volumes:
      - SnapOtter-data:/data
      - SnapOtter-workspace:/tmp/workspace
    environment:
      - AUTH_ENABLED=true
      - DEFAULT_USERNAME=admin
      - DEFAULT_PASSWORD=changeme
      - DATABASE_URL=postgres://snapotter:snapotter@postgres:5432/snapotter
      - REDIS_URL=redis://redis:6379
      - MAX_UPLOAD_SIZE_MB=200
      - CONCURRENT_JOBS=4
      - FILE_MAX_AGE_HOURS=12
    depends_on:
      postgres:
        condition: service_healthy
      redis:
        condition: service_healthy
    restart: unless-stopped

  postgres:
    image: postgres:17-alpine
    environment:
      POSTGRES_USER: snapotter
      POSTGRES_PASSWORD: snapotter     # Cambie esto para implementaciones no locales
      POSTGRES_DB: snapotter
    volumes:
      - SnapOtter-pgdata:/var/lib/postgresql/data
    restart: unless-stopped
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U snapotter -d snapotter"]
      interval: 10s
      timeout: 5s
      retries: 12

  redis:
    image: redis:8-alpine
    command: ["redis-server", "--maxmemory-policy", "noeviction", "--appendonly", "yes"]
    volumes:
      - SnapOtter-redisdata:/data
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 10s
      timeout: 5s
      retries: 12

volumes:
  SnapOtter-data:
  SnapOtter-workspace:
  SnapOtter-pgdata:
  SnapOtter-redisdata:

Volúmenes

La pila de Docker Compose usa cuatro volúmenes:

  • /data (app) - Modelos de IA, entorno virtual de Python y archivos de usuario. Móntalo para conservar los archivos subidos y los paquetes de IA instalados entre reinicios.
  • /tmp/workspace (app) - Almacenamiento temporal para los archivos que se están procesando. Puede ser efímero, pero montarlo evita llenar la capa escribible del contenedor.
  • SnapOtter-pgdata (postgres) - Directorio de datos de PostgreSQL. Contiene todos los datos relacionales (usuarios, ajustes, canalizaciones, tareas, registro de auditoría). Haz copia de seguridad mediante pg_dump o una instantánea del volumen.
  • SnapOtter-redisdata (redis) - Archivo de solo anexado de Redis para colas de tareas duraderas.