From 509d93b2976e353d29441a7a7b7e78ca466dc4fd Mon Sep 17 00:00:00 2001 From: Dennis Fink Date: Sun, 15 Nov 2026 20:42:20 +0100 Subject: refactor(core)!: standardize application terminology Rename configuration keys, task helpers, forms, network utilities, and view endpoints to make their responsibilities and domains more explicit. Align source-management routes and templates with the new terminology and rename the target-matching module and related task abstractions consistently. BREAKING CHANGE: configuration keys have been renamed and sent-source routes move from `/sent` to `/sources`, with corresponding blueprint endpoint changes. --- contrib/webmentions-ssg.example.cfg | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) (limited to 'contrib') diff --git a/contrib/webmentions-ssg.example.cfg b/contrib/webmentions-ssg.example.cfg index dead041..33f43af 100644 --- a/contrib/webmentions-ssg.example.cfg +++ b/contrib/webmentions-ssg.example.cfg @@ -46,15 +46,15 @@ SQLALCHEMY_TRACK_MODIFICATIONS = False LOG_FILE = "/var/log/webmentions-ssg.log" LOG_LEVEL = logging.INFO LOG_FORMAT = "[%(asctime)s]:%(levelname)s:%(name)s %(message)s" -LOGFILE_MAX_BYTES = 20_000_000 -LOGFILE_BACKUP_COUNT = 10 +LOG_FILE_MAX_BYTES = 20_000_000 +LOG_FILE_BACKUP_COUNT = 10 # --------------------------------------------------------------------------- # Receiving Webmentions # --------------------------------------------------------------------------- # Required: exact hostnames permitted in the 'target' field of an incoming # Webmention. Include each hostname you serve; wildcards are not supported. -ALLOWED_HOSTNAMES = {"example.com", "www.example.com"} +ALLOWED_TARGET_HOSTNAMES = {"example.com", "www.example.com"} # Maximum size of an incoming HTTP request body, including form encoding. # This global Flask limit also applies to login and administration routes. @@ -75,17 +75,17 @@ RECEIVED_RETENTION_SCHEDULE = "0 3 * * *" # validated DNS IPs, but deployment-level filtering is still necessary. # Limits for fetching/verifying incoming sources. -REQUEST_TIMEOUT = 5.0 # seconds per socket operation (both directions) -REQUEST_TOTAL_TIMEOUT = 30.0 # seconds overall, including DNS, redirects and body +REQUEST_TIMEOUT_SECONDS = 5.0 # seconds per socket operation (both directions) +REQUEST_TOTAL_TIMEOUT_SECONDS = 30.0 # seconds overall, including DNS, redirects and body MAX_REDIRECTS = 20 # also used for outgoing requests -MAX_SOURCE_BYTES = 1_000_000 +MAX_RECEIVED_SOURCE_BYTES = 1_000_000 # Requeue stuck verifications and lost queued tasks after 15 minutes. -VERIFICATION_TIMEOUT_SECONDS = 900 +VERIFICATION_STALE_AFTER_SECONDS = 900 # Max stale-row requeues before marking the Webmention failed. Manual # reverification or a new submission after the cooldown resets this counter. VERIFICATION_MAX_RECOVERIES = 3 # Huey cron expression: every five minutes (in UTC). -VERIFICATION_REAPER_SCHEDULE = "*/5 * * * *" +VERIFICATION_RECOVERY_SCHEDULE = "*/5 * * * *" # --------------------------------------------------------------------------- # Rate limiting @@ -121,13 +121,13 @@ LOGIN_USERNAME_RATE_LIMIT = "20/minute;100/hour" # --------------------------------------------------------------------------- # Folder containing generated pages named index.html. Set to None to disable # scanning. Its root-level index.html is not scanned. -SOURCE_DIRECTORY = "/var/www/example.com/public" +SITE_OUTPUT_DIRECTORY = "/var/www/example.com/public" # Needed for pages without absolute canonical URLs. -SOURCE_BASE_URL = "https://example.com/" +SITE_BASE_URL = "https://example.com/" # Huey cron expression: minute hour day-of-month month day-of-week. -SCANNER_SCHEDULE = "0 * * * *" # every hour +SOURCE_SCAN_SCHEDULE = "0 * * * *" # every hour # Temporary delivery failures use persisted exponential backoff: 1, 2, 4, # 8, then 16 hours between attempts with these defaults. After six total @@ -138,8 +138,8 @@ SEND_RETRY_BASE_SECONDS = 3600 SEND_RETRY_MAX_SECONDS = 86400 # Do not send Webmentions to your own site. Glob patterns are supported here. -IGNORED_HOSTNAMES = ("example.com", "*.example.com") -MAX_TARGET_BYTES = 1_000_000 +IGNORED_TARGET_HOSTNAMES = ("example.com", "*.example.com") +MAX_DISCOVERY_TARGET_BYTES = 1_000_000 # --------------------------------------------------------------------------- # Background tasks (Huey) @@ -174,10 +174,10 @@ HUEY_URL = "redis://127.0.0.1:6379/0" # --------------------------------------------------------------------------- # Email notifications for newly verified received Webmentions # --------------------------------------------------------------------------- -# Set NOTIFICATION_EMAIL = None to disable notification emails. -NOTIFICATION_EMAIL = "admin@example.com" +# Set DIGEST_EMAIL = None to disable notification emails. +DIGEST_EMAIL = "admin@example.com" # Daily notification digest at 08:00 UTC (Huey defaults to UTC). -NOTIFICATION_SCHEDULE = "0 8 * * *" +DIGEST_SCHEDULE = "0 8 * * *" # Example SMTP-over-STARTTLS setup; adapt to your mail provider. MAIL_SERVER = "smtp.example.com" -- cgit v1.3.1