pagetop/config/reference.toml
Manuel Cillero ce9635f9a8 ✨ (mail): Añade la extensión pagetop-mail
Envío de correo con lettre: plantillas con diseño y versión en texto,
adjuntos, transporte configurable y vista previa de mensajes.
2026-10-19 01:06:20 +02:00

213 lines
15 KiB
TOML

# ==================================================================================================
# Referencia de opciones de configuración de PageTop y sus extensiones.
#
# Este fichero NO se carga: sólo documenta todas las opciones disponibles con su valor por defecto.
# Para usarlas, copia las que necesites en alguno de los ficheros de la cascada de configuración,
# que se aplican en este orden (cada uno sobrescribe al anterior):
#
# 1. config/common.toml -> ajustes comunes a todos los entornos.
# 2. config/{rm}.toml -> ajustes del modo de ejecución (p. ej. default.toml).
# 3. config/local.{rm}.toml -> ajustes locales del modo de ejecución (no se versiona).
# 4. config/local.toml -> ajustes locales para cualquier entorno (no se versiona).
#
# Donde {rm} es el valor de la variable de entorno PAGETOP_RUN_MODE ("default" si no se define o
# está vacía). El directorio config/ puede cambiarse con la variable de entorno CONFIG_DIR (vacía
# equivale a no definirla). No hay más variables de entorno: el resto de opciones sólo se leen de
# estos ficheros.
#
# Las opciones comentadas no tienen valor por defecto; se muestran con un valor de ejemplo.
#
# En las opciones del núcleo con valores fijos ("Full", "Nearest"...) da igual escribir el valor en
# mayúsculas o minúsculas.
#
# Una clave desconocida dentro de una sección (p. ej. una errata) o un valor no válido impiden
# arrancar la aplicación, con un mensaje que indica el problema. Una sección que no corresponde a
# PageTop ni a ninguna extensión habilitada se ignora, con un aviso al arrancar.
# ==================================================================================================
# **< PageTop (núcleo) >****************************************************************************
[app]
name = "PageTop App" # Nombre de la aplicación.
theme = "Basic" # Tema predeterminado: "Basic" o el de una extensión enlazada
# por la aplicación ("Aliner", "Bootsier"...). Si no está
# habilitado se usa "Basic", con un aviso al arrancar.
#language = "es-ES" # Idioma predeterminado (BCP 47: "es-ES", "en-US"...). Sin
# valor, o si no es válido, el idioma se negocia con otras
# fuentes (cabecera Accept-Language, idioma de respaldo).
lang_negotiation = "Full" # Estrategia para resolver el idioma de cada petición:
# "Full" -> ?lang de la URL, idioma del usuario,
# 'language', Accept-Language y respaldo.
# "NoQuery" -> igual que "Full" pero sin ?lang.
# "ConfigOnly" -> sólo 'language' o el idioma de respaldo
# (no se ofrece elegir idioma al usuario).
timezone = "UTC" # Zona horaria del sitio (IANA: "UTC", "Europe/Madrid"...);
# da igual escribirla en mayúsculas o minúsculas.
# Se aplica a anónimos y a usuarios sin zona horaria propia,
# y a todos si 'timezone_per_user' es false.
timezone_regions = "" # Regiones de las zonas horarias que se ofrecen, separadas por
# comas (p. ej. "Europe, America"), elegidas entre "Africa",
# "America", "Antarctica", "Arctic", "Asia", "Atlantic",
# "Australia", "Europe", "Indian" y "Pacific". "Etc" (Etc/UTC)
# se ofrece siempre. Si está vacío se ofrecen todas. Los nombres
# desconocidos se ignoran con un aviso al arrancar; si ninguno
# es válido se ofrecen todas, y se avisa también si la región de
# 'timezone' queda fuera de las ofrecidas. No cambia las zonas
# ya asignadas a los usuarios (las conservan), sólo las nuevas
# elecciones. Es el valor por defecto del selector de zona
# horaria; la aplicación puede cambiarlo en un formulario
# concreto.
timezone_order = "Nearest" # Orden de esas regiones al elegir zona horaria:
# "Nearest" -> la del sitio primero, si tiene región, y
# luego por cercanía de su desfase horario.
# "Alphabetical" -> por el nombre de la región traducido al
# idioma de la página.
# "Listed" -> en el orden de 'timezone_regions' (sin
# regiones, como "Alphabetical").
# Es el valor por defecto del selector de zona horaria; la
# aplicación puede cambiarlo en un formulario concreto.
timezone_per_user = true # Si cada usuario puede tener su propia zona horaria (true) o
# se usa siempre 'timezone' (false). Con false no se ofrece
# elegirla y la guardada se conserva por si se reactiva.
startup_banner = "Slant" # Banner ASCII al arrancar: "Off", "Slant", "Small", "Speed"
# o "Starwars".
[dev]
pagetop_static_dir = "" # Directorio static/ de PageTop para servir sus archivos
# estáticos desde disco (editables sin recompilar). Ruta
# absoluta o relativa al proyecto (o, al ejecutar el binario,
# al directorio de trabajo). Vacío -> se sirven los incluidos
# en el binario.
[log]
enabled = true # Activa (true) o desactiva (false) las trazas.
tracing = "Info" # Filtro de trazas: "Error", "Warn", "Info", "Debug" o
# "Trace", o combinaciones separadas por comas por módulo,
# p. ej. "Info,pagetop=Debug,sqlx=Warn". Si no es válido se
# usa "Info", con un aviso al arrancar.
rolling = "Stdout" # Salida de las trazas:
# "Stdout" -> terminal, sin archivos.
# "Daily", "Hourly", "Minutely" -> archivos con rotación.
# "Endless" -> un único archivo, sin rotación.
path = "log" # Directorio de los archivos de traza (si rolling != Stdout).
prefix = "tracing.log" # Prefijo de los archivos de traza (si rolling != Stdout).
format = "Full" # Formato: "Full", "Compact", "Pretty" o "Json".
[server]
bind_address = "localhost" # Dirección de enlace del servidor web.
bind_port = 8080 # Puerto de escucha del servidor web.
# **< pagetop-seaorm >******************************************************************************
[database]
db_type = "" # Motor: "mysql" (o "mariadb"), "postgres" (o "postgresql")
# o "sqlite". Obligatorio: sin él la aplicación no arranca.
db_name = "" # Nombre (mysql/postgres) o referencia (sqlite) de la BD.
db_user = "" # Usuario de conexión (mysql/postgres).
db_pass = "" # Contraseña de conexión (mysql/postgres).
db_host = "localhost" # Servidor de la base de datos (mysql/postgres).
#db_port = 5432 # Puerto (mysql/postgres). Sin valor -> 3306 para MySQL y
# 5432 para PostgreSQL.
max_pool_size = 5 # Número máximo de conexiones simultáneas.
# **< pagetop-mail >********************************************************************************
[mail]
transport = "log" # Entrega de los correos:
# "smtp" -> servidor SMTP ([mail.smtp]).
# "sendmail" -> programa sendmail local ([mail.sendmail]).
# "file" -> un archivo .eml por correo ([mail.file]).
# "log" -> se escriben en las trazas, sin enviarlos.
# "memory" -> se guardan en memoria (sólo pruebas).
#from = "Mi Aplicación <no-reply@example.com>"
# Remitente por defecto, con o sin nombre. Sin valor, cada
# correo debe indicar el suyo.
#reply_to = "soporte@example.com" # Dirección de respuesta por defecto.
#redirect_to = "pruebas@example.com" # Entrega todos los correos sólo a esta dirección, sin
# cambiar sus cabeceras (entornos de pruebas o preproducción).
#base_url = "https://example.com" # URL pública para los enlaces de los correos. Sin valor,
# http://{bind_address}:{bind_port} (sólo para desarrollo).
previews = false # Vistas previas de los correos en /mail/preview. Sólo en
# desarrollo: cualquiera que conozca la ruta las ve.
[mail.smtp] # Servidor SMTP (transport = "smtp").
host = "localhost" # Servidor.
#port = 587 # Puerto. Sin valor -> 465 con "tls", 587 con "starttls" y 25
# en otro caso.
security = "starttls" # Cifrado de la conexión:
# "none" -> sin cifrar (servidores de pruebas).
# "opportunistic" -> STARTTLS si el servidor lo ofrece.
# "starttls" -> STARTTLS obligatorio (puerto 587).
# "tls" -> cifrada desde el inicio (puerto 465).
#username = "no-reply@example.com" # Usuario. Sin valor, no se autentica.
#password = "secreto" # Contraseña. Mejor en config/local.toml (no se versiona).
#hello_name = "example.com" # Nombre para EHLO. Sin valor, el nombre del equipo.
timeout_secs = 60 # Espera máxima de cada orden al servidor, en segundos.
pool_max_size = 10 # Conexiones abiertas como máximo, reutilizadas entre envíos.
accept_invalid_certs = false # Acepta certificados no válidos. PELIGROSO: sólo pruebas.
[mail.sendmail] # Programa sendmail (transport = "sendmail").
#command = "/usr/sbin/sendmail" # Programa. Sin valor, "sendmail" del PATH.
[mail.file] # Archivos de correo (transport = "file").
dir = "mail" # Directorio de los archivos .eml. Se crea si no existe.
# **< pagetop-user >********************************************************************************
[user]
allow_registration = true # Permite que los visitantes creen su propia cuenta.
require_email_verification = false # Las cuentas nuevas quedan pendientes ("Pending") en lugar
# de activas hasta verificar el correo.
max_failed_logins = 5 # Intentos fallidos de acceso antes de bloquear la cuenta.
failed_login_window_secs = 900 # Ventana de recuento de intentos fallidos (15 minutos).
# Reservada: todavía no tiene efecto.
locked_for_secs = 600 # Duración del bloqueo de la cuenta en segundos (10 minutos).
login_strict = false # Dificulta que el navegador recuerde o autorrellene las
# credenciales en el formulario de acceso.
[user.session] # Sesiones de usuario.
cookie_name = "pagetop" # Nombre de la cookie de sesión.
secure_cookie = false # Marca la cookie como Secure (sólo HTTPS). Activar en
# producción.
idle_secs = 7200 # Segundos sin uso tras los que caduca la sesión si no se marca
# "recordarme" al acceder (2 horas). Se cuentan desde la última
# petición.
remember_idle_secs = 1209600 # Segundos sin uso tras los que caduca la sesión si se marca
# "recordarme" al acceder (14 días). Se cuentan igual.
write_interval_secs = 60 # Segundos mínimos entre dos escrituras de la misma sesión en la
# base de datos para prorrogarla. La sesión puede caducar hasta
# este tiempo antes de lo configurado. Subirlo (p. ej. 180)
# reduce escrituras con mucho tráfico o una base de datos lenta;
# bajarlo (o 0, escribir siempre) da más precisión si las
# sesiones caducan tras pocos minutos sin uso.
[user.password] # Contraseñas, cifradas con Argon2id.
argon2_m_cost = 19456 # Coste de memoria en KiB. Si cambia, las contraseñas se
# vuelven a cifrar en el siguiente acceso de cada usuario.
argon2_t_cost = 2 # Coste de tiempo (número de iteraciones).
argon2_p_cost = 1 # Grado de paralelismo (número de hilos).
min_length = 8 # Longitud mínima de las contraseñas.
[user.seed] # Primer administrador, creado si no existe ningún usuario.
admin_username = "admin" # Nombre de usuario.
admin_email = "admin@example.com" # Correo electrónico.
#admin_password = "cambiar" # Contraseña. Sin valor -> se genera una aleatoria y se
# muestra una sola vez por la salida estándar al crearlo.
[user.admin]
list_page_size = 20 # Filas por página en los listados de administración
# (usuarios, roles...).
# **< pagetop-bootsier >****************************************************************************
[bootsier]
max_width = "1440px" # Ancho máximo de la página ("100%", "90rem", "1440px"...).
static_dir = "" # Directorio static/ de pagetop-bootsier para servir sus
# archivos estáticos desde disco, como pagetop_static_dir.