Text
Browse by topic
Explore related documentation through its most useful keyword groups.
1438 items
Grouped by Architecture
A named transformation applied to a value inside a template expression.
Explore this clusterA typed event or request exchanged between decoupled Zotonic components through the notifier.
A namespaced interface for retrieving or changing data and invoking operations in Zotonic or browser-side components.
Explore this clusterAn OTP application or site component that adds Zotonic behavior templates data and configuration.
Explore this clusterA server-defined browser action or event binding connected through Zotonic wires.
Explore this clusterA server-side template_compiler document that renders data into HTML text email or another representation.
Explore this clusterA request handler that maps web requests to responses and coordinates authorization rendering or data transfer.
Explore this clusterA route declaration that matches a URL pattern and selects a controller with arguments.
Explore this clusterThe central Zotonic entity that represents content users media categories and other addressable objects.
Explore this clusterDocumentation not covered by the other keyword groups in this split.
Explore this clusterExtract the SMTP diagnostic from legacy {bounce, <<"...">>} and related mailing-run details, including nested errors and missing diagnostics. New details are…
Administrator-only traffic guard rules and current rate-limited IPs.
Administrator-only IP allow and block list editor. Responses are not cached or indexed. Save events call the model, which separately enforces administrator and…
URL dispatch rules defined by mod_traffic_guard in apps/zotonic_mod_traffic_guard/priv/dispatch/dispatch.
Traffic Guard detects and limits excessive requests from individual IP addresses. It protects a site from rapid crawling and repeated page requests, including…
Develop Zotonic sites with LLM tools Give an LLM access to the running site's dispatch rules, resolved templates, model documentation, and rendering evidence.
Help agents discover a site's public APIs Enable mod_agent_discovery on a public publishing site, using the Modules page in the admin. It depends on mod_base…
Public discovery metadata, always evaluated with anonymous permissions.
Bounded anonymous reads: search, resource/+id, related/+id and schema. Requests accept binary-keyed maps. Public listings exclude noindex resources. Direct…
Anonymous GET/HEAD projections. Recompute authorization and content before conditional requests; caches must revalidate every use. Errors are never cached.
Serve public agent discovery documents with GET and HEAD. The dispatch option document selects llms , catalog , openapi or help . Rendering uses anonymous…
URL dispatch rules defined by mod_agent_discovery in apps/zotonic_mod_agent_discovery/priv/dispatch/dispatch.
Advertise bounded anonymous reads and existing resource export through /llms.txt , /.well-known/api-catalog , /openapi.json and /api-help .
Inspect a running site's dispatch rules, template resolution, source, composition, and available model APIs. Combine this model with model#development_capture…
Capture template rendering and browser console output from an open page without losing its current state. Use this model with model#development_tools to…
Handle Buckaroo checkout callbacks.
This file defines the URL dispatch rules for mod_payment_buckaroo . Rules are matched from top to bottom; the first matching rule handles the request.
Create Buckaroo transactions and normalize their verified status updates.
Handle Buckaroo checkout callbacks.
Provide Buckaroo checkout and verified payment pushes through mod_payment .
Provide PayPal Orders checkout through mod_payment .
Handle PayPal checkout callbacks.
This file defines the URL dispatch rules for mod_payment_paypal . Rules are matched from top to bottom; the first matching rule handles the request.
Create, capture and synchronize PayPal Orders and verify webhook events.
Handle PayPal checkout callbacks.
The webhooks model path exposes effective webhook configuration to administrators only. A .test hostname is a local-development heuristic, not an Internet…
Handle Mollie checkout callbacks.
Look up the current API key's profile, or all profiles accessible to the optional profiles_access_token with profiles.read permission. The list model path…
Provide Mollie payments and recurring subscriptions through mod_payment .
This file defines the URL dispatch rules for mod_payment_mollie . Rules are matched from top to bottom; the first matching rule handles the request.
Call Mollie and translate payments and subscriptions into local payment updates.
Provide Stripe Checkout payments through mod_payment .
This file defines the URL dispatch rules for mod_payment_stripe . Rules are matched from top to bottom; the first matching rule handles the request.
Create and synchronize Stripe payment-mode Checkout Sessions.
Handle Stripe checkout callbacks.
Handle Stripe checkout callbacks.
Local development with Docker on Windows Keep Zotonic in Ubuntu's Linux filesystem and use Windows launchers for everyday work. This avoids the slow Windows…
Read Site Analytics reports, manage recordings and submit trusted server-side events.
Serve the Site Analytics dashboard and its separate recording configuration page. Responses disable caching and search-engine indexing.
URL dispatch rules defined by mod_analytics in apps/zotonic_mod_analytics/priv/dispatch/dispatch.
Site Analytics measures site traffic, popular content, outgoing email activity and module-defined events without an external tracker. It helps operators…
Declare events that Site Analytics can record. This is a foldl notification, starting with an empty list. Prepend your declarations to the accumulator and…
Running media processing on a separate host Image resizing, PDF previews and video conversion can use considerable CPU, memory and temporary disk space. The…
How Zotonic stores and collects media files Zotonic separates a media resource's identity from its file bytes. A resource has a medium record with a logical…
Site-local content-addressable file storage (CAFS) for originals, explicit previews such as video posters, and generated image variants. Identical bytes share…
Resolve credentials for a file already registered at a remote service and location.
Perform a direct, synchronous filestore upload, download or deletion.
Contribute normalized resource edit settings to the signed preview revision. Return a list with {Module, Settings} prepended to the accumulator. Contributions…
Resolve managed file storage operations. Records are defined in zotonic_file.hrl .
Resolve a local storage path to a remote service, destination and credentials.
URL dispatch rules defined by mod_site_update in apps/zotonic_mod_site_update/priv/dispatch/admin_dispatch.
Flatten admin dropdown subgroups into headings and links, with separators around groups. Remove leading, trailing and consecutive separators after flattening
Deploy the latest Git changes to a running Zotonic node.
Translating interface messages Zotonic uses English source messages and gettext PO catalogs for interface translations. Language configuration and selection…
Erlang translation API: z_trans z_trans is part of zotonic_core . It resolves gettext interface messages and language alternatives. For concepts and catalog…
Set a template's default gettext message context:
Override gettext message context for a lexical scope:
Test if an amount and currency can be used for a payment request.
Append audit events to a payment's log from trusted server code.
This file defines the URL dispatch rules for mod_payment . Rules are matched from top to bottom; the first matching rule handles the request.
Show a payment currency using its preferred symbol or short form.
Read payment data and maintain local payment records.
Expose editable configuration for active payment modules.
Manage payment requests, local payment records, status notifications and PSP adapters.
Menu queries and removal support. The query paths reuse the menu filters:
Escape a value for an iCalendar TEXT property, such as SUMMARY, DESCRIPTION or LOCATION. Backslashes, commas and semicolons are escaped with a backslash. CRLF…
model/password Toggles password visibility in the browser. Implemented in the wires script, loaded by the standard Zotonic JavaScript includes. It works with…
Serve /feed , /feed/:type and /feed/:type/:id with optional search arguments. Types are atom, rss, jsonfeed, json (an alias for JSON Feed), and ics/ical.
Look up imported Wikidata/OpenAlex concepts, search their names and connect them to keyword resources. Concept rows are binary-keyed maps, with properties from…
This file defines the URL dispatch rules for mod_wikiconcept . Rules are matched from top to bottom; the first matching rule handles the request.
Import Wikidata concepts from OpenAlex and connect them to Zotonic keyword resources. Imported concepts and multilingual search names are stored locally
Relay messages, resolve signed links and queue callbacks for mod_secure_message . Message records are returned as atom-keyed property lists; relay requests and…
This file defines the URL dispatch rules for mod_secure_message . Rules are matched from top to bottom; the first matching rule handles the request.
Store short-lived messages on the site and email recipients a signed link instead of the message body. Recipients can read, reply to and delete a message…
Access local payment and subscription records, membership state and provider customer portals. Database records generally use binary map keys. Template paths…
Manage paid memberships, customers, products, prices, subscriptions, invoices and payments. The bundled payment-service integration uses Stripe. Local records…
Receive Stripe payment and subscription events with POST at /paysub/stripe/webhook (dispatch paysub_stripe_webhook ). Generate the absolute endpoint URL in a…
Provide geographic filter choices and subscription searches for Paysub.
This file defines the URL dispatch rules for mod_paysub . Rules are matched from top to bottom; the first matching rule handles the request.
Show who is viewing a shared location using browser presence messages. Enable mod_presence on the site; no module configuration keys are required. The widgets…
Look up a rate or convert a numeric amount with mod_exchange_rates .
Read currency rates and convert amounts using the site's mod_exchange_rates server. Rates express currency units per USD and may be retained from earlier…
Fetch currency exchange rates from the ECB daily XML feed and expose them through m_exchange_rates , the exchange_rates template filter and Erlang functions.
Relay outgoing email through the Mailgun HTTP API and receive delivery and engagement events through a signed webhook. Requires mod_email_status .
This file defines the URL dispatch rules for mod_mailgun . Rules are matched from top to bottom; the first matching rule handles the request.
Receive Mailgun event callbacks at /mailgun-webhook (dispatch name mailgun_webhook ). Accepts POST with content type application/json . Generate the site's…
Resolve JavaScript dependencies for automatic widget loading in module#mod_wires. The widget manager uses this model when a do_<name> class has no registered…
Share protected pages, images and feeds using signed URLs with the signing user's view permissions. Recipients do not need to log in as that user. Typical uses…
Generate absolute resource page URLs signed with the current user's view permissions. Requires mod_access_url to be enabled. Opening the link does not log the…
Convert an underscore-separated identifier to a readable label.
Persistent feed activity, accessible to users allowed to use mod_import_feed . m.import_feed_log.list[FeedId][BeforeId] returns up to 100 events older than the…
Format a source filename for display in development tools. Resolves symbolic links in both files and parent directories, then removes the Zotonic root…
Adds a rich-text editor based on Tiptap and ProseMirror to Zotonic forms. It provides headings, emphasis, lists, links, Zotonic media, tables, undo/redo, and…
Discover, preview and manage the feeds imported by mod_import_feed .
URL dispatch rules defined by mod_import_feed in apps/zotonic_mod_import_feed/priv/dispatch/dispatch.
Discover RSS 2.0, RSS 1.0/RDF, Atom, JSON Feed 1/1.1 and iCalendar feeds and automatically import articles and media.
Coordinate changes and verify service before reopening access.
Verify host, role, database, and schema before restarting a site.
Separate environments and record how the site is operated.
Apply a tested revision and check the site from a visitor’s perspective.