Browse by topic

Discover Text

Explore related documentation through its most useful keyword groups.

1438 items

Grouped by Architecture

All Text

Filters

mailinglist_delivery_detail

Extract the SMTP diagnostic from legacy {bounce, <<"...">>} and related mailing-run details, including nested errors and missing diagnostics. New details are…

Models

traffic_guard

Administrator-only traffic guard rules and current rate-limited IPs.

Controllers

controller_admin_traffic_guard

Administrator-only IP allow and block list editor. Responses are not cached or indexed. Save events call the model, which separately enforces administrator and…

Modules

mod_traffic_guard

Traffic Guard detects and limits excessive requests from individual IP addresses. It protects a site from rapid crawling and repeated page requests, including…

Developer guide

Develop Zotonic sites with LLM tools

Develop Zotonic sites with LLM tools Give an LLM access to the running site's dispatch rules, resolved templates, model documentation, and rendering evidence.

Developer guide

Help agents discover a site's public APIs

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…

Models

agent_discovery

Public discovery metadata, always evaluated with anonymous permissions.

Models

agent_content

Bounded anonymous reads: search, resource/+id, related/+id and schema. Requests accept binary-keyed maps. Public listings exclude noindex resources. Direct…

Controllers

controller_agent_content

Anonymous GET/HEAD projections. Recompute authorization and content before conditional requests; caches must revalidate every use. Errors are never cached.

Controllers

controller_agent_discovery

Serve public agent discovery documents with GET and HEAD. The dispatch option document selects llms , catalog , openapi or help . Rendering uses anonymous…

Modules

mod_agent_discovery

Advertise bounded anonymous reads and existing resource export through /llms.txt , /.well-known/api-catalog , /openapi.json and /api-help .

Models

development_tools

Inspect a running site's dispatch rules, template resolution, source, composition, and available model APIs. Combine this model with model#development_capture…

Models

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…

Modules

mod_payment_buckaroo

Provide Buckaroo checkout and verified payment pushes through mod_payment .

Models

m_payment_paypal_api

Create, capture and synchronize PayPal Orders and verify webhook events.

Models

m_payment_mollie_config

The webhooks model path exposes effective webhook configuration to administrators only. A .test hostname is a local-development heuristic, not an Internet…

Models

m_payment_mollie_profiles

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…

Modules

mod_payment_mollie

Provide Mollie payments and recurring subscriptions through mod_payment .

Models

m_payment_mollie_api

Call Mollie and translate payments and subscriptions into local payment updates.

Developer guide

Local development with Docker on Windows

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…

Models

analytics

Read Site Analytics reports, manage recordings and submit trusted server-side events.

Controllers

controller_admin_analytics

Serve the Site Analytics dashboard and its separate recording configuration page. Responses disable caching and search-engine indexing.

Dispatch rules

mod_analytics dispatch rules

URL dispatch rules defined by mod_analytics in apps/zotonic_mod_analytics/priv/dispatch/dispatch.

Modules

mod_analytics

Site Analytics measures site traffic, popular content, outgoing email activity and module-defined events without an external tracker. It helps operators…

Developer guide

Running media processing on a separate host

Running media processing on a separate host Image resizing, PDF previews and video conversion can use considerable CPU, memory and temporary disk space. The…

Developer guide

How Zotonic stores and collects media files

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…

Models

cafs

Site-local content-addressable file storage (CAFS) for originals, explicit previews such as video posters, and generated image variants. Identical bytes share…

Notifications

observe_media_preview_revision/3

Contribute normalized resource edit settings to the signed preview revision. Return a list with {Module, Settings} prepended to the accumulator. Contributions…

Notifications

observe_filestore/2

Resolve managed file storage operations. Records are defined in zotonic_file.hrl .

Filters

admin_menu_items

Flatten admin dropdown subgroups into headings and links, with separators around groups. Remove leading, trailing and consecutive separators after flattening

Developer guide

Translating interface messages

Translating interface messages Zotonic uses English source messages and gettext PO catalogs for interface translations. Language configuration and selection…

Reference

Erlang translation API: z_trans

Erlang translation API: z_trans z_trans is part of zotonic_core . It resolves gettext interface messages and language alternatives. For concepts and catalog…

Tags

msgctxt

Set a template's default gettext message context:

Tags

with_msgctxt

Override gettext message context for a lexical scope:

Models

m_payment_log

Append audit events to a payment's log from trusted server code.

Dispatch rules

mod_payment dispatch rules (dispatch)

This file defines the URL dispatch rules for mod_payment . Rules are matched from top to bottom; the first matching rule handles the request.

Models

m_payment

Read payment data and maintain local payment records.

Models

m_payment_config

Expose editable configuration for active payment modules.

Modules

mod_payment

Manage payment requests, local payment records, status notifications and PSP adapters.

Models

menu

Menu queries and removal support. The query paths reuse the menu filters:

Filters

escape_ical_text

Escape a value for an iCalendar TEXT property, such as SUMMARY, DESCRIPTION or LOCATION. Backslashes, commas and semicolons are escaped with a backslash. CRLF…

Cotonic models

model/password Cotonic

model/password Toggles password visibility in the browser. Implemented in the wires script, loaded by the standard Zotonic JavaScript includes. It works with…

Controllers

controller_feed

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.

Models

m_wikiconcept

Look up imported Wikidata/OpenAlex concepts, search their names and connect them to keyword resources. Concept rows are binary-keyed maps, with properties from…

Modules

mod_wikiconcept

Import Wikidata concepts from OpenAlex and connect them to Zotonic keyword resources. Imported concepts and multilingual search names are stored locally

Models

m_secure_message

Relay messages, resolve signed links and queue callbacks for mod_secure_message . Message records are returned as atom-keyed property lists; relay requests and…

Modules

mod_secure_message

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…

Models

m_paysub

Access local payment and subscription records, membership state and provider customer portals. Database records generally use binary map keys. Template paths…

Modules

mod_paysub

Manage paid memberships, customers, products, prices, subscriptions, invoices and payments. The bundled payment-service integration uses Stripe. Local records…

Controllers

controller_paysub_stripe_webhook

Receive Stripe payment and subscription events with POST at /paysub/stripe/webhook (dispatch paysub_stripe_webhook ). Generate the absolute endpoint URL in a…

Models

m_paysub_search

Provide geographic filter choices and subscription searches for Paysub.

Dispatch rules

mod_paysub dispatch rules (dispatch)

This file defines the URL dispatch rules for mod_paysub . Rules are matched from top to bottom; the first matching rule handles the request.

Modules

mod_presence

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…

Models

m_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…

Modules

mod_exchange_rates

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.

Modules

mod_mailgun

Relay outgoing email through the Mailgun HTTP API and receive delivery and engagement events through a signed webhook. Requires mod_email_status .

Controllers

controller_mailgun_webhook

Receive Mailgun event callbacks at /mailgun-webhook (dispatch name mailgun_webhook ). Accepts POST with content type application/json . Generate the site's…

Models

wires

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…

Modules

mod_access_url

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…

Models

m_access_url

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…

Models

import_feed_log

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…

Filters

development_filename

Format a source filename for display in development tools. Resolves symbolic links in both files and parent directories, then removes the Zotonic root…

Modules

mod_editor_tiptap

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…

Models

import_feed

Discover, preview and manage the feeds imported by mod_import_feed .

Modules

mod_import_feed

Discover RSS 2.0, RSS 1.0/RDF, Atom, JSON Feed 1/1.1 and iCalendar feeds and automatically import articles and media.