Text
Browse by topic
Discover Text
Explore related documentation through its most useful keyword groups.
1381 items
Grouped by Architecture
Template filter
200 itemsA named transformation applied to a value inside a template expression.
Explore this clusterNotification
164 itemsA typed event or request exchanged between decoupled Zotonic components through the notifier.
- Add a named resource search
- Assign a user group from a trusted creation workflow
- Choose a model, controller, observer, or component
Model
124 itemsA namespaced interface for retrieving or changing data and invoking operations in Zotonic or browser-side components.
Explore this clusterModule
112 itemsAn OTP application or site component that adds Zotonic behavior templates data and configuration.
Explore this clusterWire action
110 itemsA server-defined browser action or event binding connected through Zotonic wires.
Explore this clusterTemplate
101 itemsA server-side template_compiler document that renders data into HTML text email or another representation.
Explore this clusterDispatch rule
65 itemsA route declaration that matches a URL pattern and selects a controller with arguments.
Explore this clusterController
63 itemsA request handler that maps web requests to responses and coordinates authorization rendering or data transfer.
Explore this clusterResource
55 itemsThe central Zotonic entity that represents content users media categories and other addressable objects.
Explore this clusterOther
508 itemsDocumentation not covered by the other keyword groups in this split.
Explore this clusterAll Text
m_payment
Read payment data and maintain local payment records.
m_payment_log
Append audit events to a payment's log from trusted server code.
filter_payment_is_valid
Test if an amount and currency can be used for a payment request.
mod_payment
Manage payment requests, local payment records, status notifications and PSP adapters.
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.
m_payment_config
Expose editable configuration for active payment modules.
filter_payment_currency_symbol
Show a payment currency using its preferred symbol or short form.
menu
Menu queries and removal support. The query paths reuse the menu 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…
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…
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.
mod_wikiconcept
Import Wikidata concepts from OpenAlex and connect them to Zotonic keyword resources. Imported concepts and multilingual search names are stored locally
mod_wikiconcept dispatch rules (dispatch)
This file defines the URL dispatch rules for mod_wikiconcept . Rules are matched from top to bottom; the first matching rule handles the request.
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…
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…
mod_secure_message dispatch rules (dispatch)
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.
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…
m_paysub
Access local payment and subscription records, membership state and provider customer portals. Database records generally use binary map keys. Template paths…
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.
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…
m_paysub_search
Provide geographic filter choices and subscription searches for Paysub.
mod_paysub
Manage paid memberships, customers, products, prices, subscriptions, invoices and payments. The bundled payment-service integration uses Stripe. Local records…
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…
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…
filter_exchange_rates
Look up a rate or convert a numeric amount with mod_exchange_rates .
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.
mod_mailgun
Relay outgoing email through the Mailgun HTTP API and receive delivery and engagement events through a signed webhook. Requires mod_email_status .
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…
mod_mailgun dispatch rules (dispatch-mailgun)
This file defines the URL dispatch rules for mod_mailgun . Rules are matched from top to bottom; the first matching rule handles the request.
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…
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…
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…
humanize_identifier
Convert an underscore-separated identifier to a readable label.
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…
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…
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…
import_feed
Discover, preview and manage the feeds imported by mod_import_feed .
mod_import_feed dispatch rules
URL dispatch rules defined by mod_import_feed in apps/zotonic_mod_import_feed/priv/dispatch/dispatch.
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.
Plan and apply an upgrade
Test version-specific changes and establish a recovery point.
Diagnose missing or failed email
Trace one message from request to recipient.
Enable or disable a site feature
Change module activation and verify the affected workflow.
Rehearse a complete site restore
Restore into isolation and verify content, media, and access.
Configure and check persistent media storage
Keep original uploads accessible across deployments and restarts.
Configure hostnames and HTTPS
Align DNS, site selection, and certificate termination.
Change persistent configuration
Choose the right configuration layer and verify the effective value.
Set upload sizes and allowed file types
Adjust group upload limits and test with an ordinary account.
Prepare an acceptance or production environment
Separate environments and record how the site is operated.
Define what a complete backup includes
Choose recovery coverage, retention, and an owner.
Configure outbound email and verify delivery
Set a relay at the correct scope and test a real site message.
Diagnose a site that will not start
Separate node, site, database, and application failures.
Add a language and choose its availability
Prepare translations before making a language visible to visitors.
Configure media sandboxing and an optional media runner
Check media-process isolation and decide whether to run conversions on a separate service.
Check or change a site database connection
Verify host, role, database, and schema before restarting a site.
Run a planned maintenance window
Coordinate changes and verify service before reopening access.
Create and check a site backup
Request a backup and verify its completion and scope.
Recover one page without restoring the whole site
Use revisions or deleted-page recovery for an editorial mistake.
Deploy and verify a release
Apply a tested revision and check the site from a visitor’s perspective.
Diagnose failed uploads or missing media
Locate the failure in permission, storage, or processing.
Hand over an incident and record recovery
Give the next operator enough context to continue safely.
Direct test mail to a controlled recipient
Prevent an acceptance workflow from emailing real users.
Configure service startup and restart behaviour
Run Zotonic under the installation’s service manager.
Read logs and collect useful evidence
Find the relevant failure without exposing credentials or personal data.
Prepare and carry out recovery from a failed release
Recover code and data to a compatible state.
Check that a site is working
Monitor the user-facing service as well as its processes.
siteconfigfiles: List configuration files selected for a site
List configuration files selected for a site.
shell: Connect an Erlang shell to the running node
Connect an Erlang shell to the running node.
Use the Nix development shell
Enter the supplied OTP 28 development shell, prepare PostgreSQL, and build.
start_nodaemon: Start Zotonic in the foreground without an interactive shell
Start Zotonic in the foreground without an interactive shell.
Prepare local PostgreSQL
Create and check the database used by a native development installation.
Choose the site admin or the status site
Use the right management surface and account.
startsite: Start a selected site on the node
Start a selected site on the node.
resetratelimit: Reset a site rate limiter
Reset a site rate limiter.
decrypt: Decrypt a local encrypted backup file
Decrypt a local encrypted backup file.
stop: Stop the Zotonic node
Stop the Zotonic node.
dispatch: Inspect dispatch rules or trace a URL
Inspect dispatch rules or trace a URL.
pot: Generate gettext translation template files
Generate gettext translation template files.
logtail: Print recent lines from a configured log file
Print recent lines from a configured log file.
setconfig: Set a global runtime Zotonic value
Set a global runtime Zotonic value.
etop: Inspect active Erlang processes
Inspect active Erlang processes.
configtest: Check whether global configuration files can be read
Check whether global configuration files can be read.
Remove access when someone leaves
Remove login methods and permissions without deleting their authored content.
load: Load changed BEAM files
Load changed BEAM files.
rpc: Call an exported Erlang function on the node
Call an exported Erlang function on the node.
status: Show node and site state
Show node and site state.
wait: Wait until the node answers a ping
Wait until the node answers a ping.
open: Open the site URL in a browser
Open the site URL in a browser.
start: Start Zotonic in the background
Start Zotonic in the background.
Review accounts and shared responsibilities
Find obsolete access and verify who can administer the site.
restartsite: Restart one site
Restart one site.
sitedir: Show a site application directory
Show a site application directory.
flush: Flush site caches
Flush site caches.
debug: Start Zotonic in the foreground with an Erlang shell
Start Zotonic in the foreground with an Erlang shell.
update: Compile, load, flush, and rescan the server
Compile, load, flush, and rescan the server.
Install on macOS or Linux
Install the native tools, prepare PostgreSQL, and build a local checkout.
sitetest: Run site tests using an isolated test schema
Run site tests using an isolated test schema.
runtests: Run selected core test modules
Run selected core test modules.
Test and publish access rules
Check a rule change before it affects everyone.
siteconfig: Display a site configuration resolved from files
Display a site configuration resolved from files.
Assign user groups and check access
Give an account the permissions required for its work.