Skip to Content
Atlassian Confluenceacs2mdv1.0.xConfiguración

Configuración

Este modelo de configuración aplica solo a Atlassian Confluence Cloud. acs2md no es compatible con Confluence Server ni Confluence Data Center.

Las versiones publicadas están disponibles actualmente solo para macOS y Linux. No hay artefactos publicados para Windows en la versión actual.

acs2md aplica la configuración desde cuatro fuentes, en orden de prioridad ascendente:

PrioridadFuenteEjemplo
1 (más baja)Valores predeterminados integrados
2Archivo de configuración(ver más abajo)
3Variables de entornoACS2MD_CONFLUENCE_DOMAIN
4 (más alta)Flags de CLI--log-level debug

En la practica, esto permite a los equipos separar valores persistentes de la estacion de trabajo, ajustes puntuales por ejecución y gestion de secretos especifica de la automatizacion.

Ubicacion del archivo de configuración

La ubicacion predeterminada del archivo de configuración depende del sistema operativo. Ejecuta:

acs2md config where

Uso recomendado:

  • guarda los valores no secretos en el archivo de configuración
  • inyecta secretos mediante variables de entorno cuando sea posible
  • reserva los flags de CLI para overrides puntuales y depuracion

Para crear un archivo de configuración con todos los valores por defecto rellenados:

acs2md config create

~/Library/Application Support/acs2md/

          • config.yaml
          • license.bin

Referencia completa del archivo de configuración

# Conexion con Confluence confluence: domain: mycompany.atlassian.net # Dominio de tu instancia de Confluence username: you@example.com # Correo de tu cuenta de Atlassian api_token: YOUR_API_TOKEN # API token de id.atlassian.com # Comportamiento del cliente HTTP http: client: max_retries: 3 # Numero de reintentos tras un fallo base_timeout: 10ms # Timeout inicial de la petición max_timeout: 100ms # Timeout máximo despues de reintentos proxy: "" # URL del proxy HTTP (ej. http://proxy.corp:8080) # Logging log: level: info # debug | info | warn | error format: text # text | json file: "" # Ruta del log; stdout | stderr | /path/to/file.log # Cada ejecución trunca el archivo # Modo debug debug: enabled: false # Activa salida de depuración detallada dir: debug # Directorio para artefactos de depuración # Gestión de imágenes image: cache_dir: "" # Define esto solo si quieres fijar una caché compartida max_size_bytes: 10485760 # Tamaño máximo por imagen (10 MB por defecto)

Cuando image.cache_dir queda sin definir, las configuraciones generadas suelen omitir la clave para mantener el comportamiento por defecto orientado a la salida. En ese modo, acs2md ancla la caché en <output-dir>/<space-key>/.image_cache junto al archivo de estado, o en ./.image_cache cuando escribe en stdout. La clave del espacio siempre se añade a --output-dir. Define image.cache_dir explícitamente solo cuando necesites una ubicación fija de caché compartida entre exportaciones.

Variables de entorno

Cada clave de configuración puede definirse con una variable de entorno añadiendo el prefijo ACS2MD_ y sustituyendo . por _:

Variable de entornoClave de configuraciónDescripción
ACS2MD_CONFLUENCE_DOMAINconfluence.domainDominio de la instancia de Confluence
ACS2MD_CONFLUENCE_USERNAMEconfluence.usernameCorreo de la cuenta de Atlassian
ACS2MD_CONFLUENCE_API_TOKENconfluence.api_tokenToken API de Confluence
ACS2MD_HTTP_CLIENT_MAX_RETRIEShttp.client.max_retriesNúmero de reintentos
ACS2MD_HTTP_CLIENT_BASE_TIMEOUThttp.client.base_timeoutTiempo de espera base de la petición
ACS2MD_HTTP_CLIENT_MAX_TIMEOUThttp.client.max_timeoutTiempo de espera máximo
ACS2MD_HTTP_CLIENT_PROXYhttp.client.proxyURL del proxy HTTP
ACS2MD_LOG_LEVELlog.levelNivel de logging
ACS2MD_LOG_FORMATlog.formatFormato del logging
ACS2MD_LOG_FILElog.fileArchivo de salida del logging
ACS2MD_DEBUG_ENABLEDdebug.enabledActiva el modo debug
ACS2MD_IMAGE_CACHE_DIRimage.cache_dirDirectorio de caché de imágenes
ACS2MD_IMAGE_MAX_SIZE_BYTESimage.max_size_bytesTamaño máximo de imagen

Flags globales de CLI

Estos flags están disponibles en todos los comandos:

FlagPredeterminadoDescripcion
--config-file(ver config where)Ruta a un archivo de configuración personalizado
--log-levelinfoVerbosidad del log: debug, info, warn, error
--log-formattextFormato del log: text o json
--log-file(descartar)Escribe logs en stdout, stderr o una ruta de archivo
--debugfalseAtajo de --log-level=debug
--image-cache-dir(ninguno)Directorio para cachear imagenes descargadas
--image-max-size-bytes10485760Tamano máximo en bytes para imagenes cacheadas

Practicas seguras de configuración

  • Prefiere variables de entorno para API tokens en sistemas compartidos o gestionados.
  • Usa config create para establecer la estructura esperada del archivo antes de editarlo manualmente.
  • Ejecuta doctor despues de cambios de configuración para validar juntos licencia, credenciales y conectividad.
  • Usa un --config-file personalizado cuando necesites configuraciones aisladas de prueba y produccion en la misma máquina.

Detras de un proxy corporativo

acs2md config set http.client.proxy "http://proxy.corp.example.com:8080"

Con autenticación:

acs2md config set http.client.proxy "http://user:password@proxy.corp.example.com:8080"

Evita almacenar credenciales del proxy en el archivo de configuración si se comparte o esta versionado. Usa en su lugar la variable de entorno ACS2MD_HTTP_CLIENT_PROXY.

Escribir logs en un archivo

acs2md space convert by-key MYSPACE --log-file acs2md.log

Cada ejecución trunca el archivo de log, por lo que siempre contiene solo la salida de la ejecución mas reciente. Usa stdout o stderr para enviar logs directamente a tu terminal:

acs2md space convert by-key MYSPACE --log-file stdout
Last updated on