Text
Browse by topic
Discover Text
Explore related documentation through its most useful keyword groups.
1342 items
Grouped by Architecture
Template filter
194 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
Wire action
110 itemsA server-defined browser action or event binding connected through Zotonic wires.
Explore this clusterModel
110 itemsA namespaced interface for retrieving or changing data and invoking operations in Zotonic or browser-side components.
Explore this clusterModule
102 itemsAn OTP application or site component that adds Zotonic behavior templates data and configuration.
Explore this clusterTemplate
101 itemsA server-side template_compiler document that renders data into HTML text email or another representation.
Explore this clusterController
60 itemsA request handler that maps web requests to responses and coordinates authorization rendering or data transfer.
Explore this clusterDispatch rule
59 itemsA route declaration that matches a URL pattern and selects a controller with arguments.
Explore this clusterResource
55 itemsThe central Zotonic entity that represents content users media categories and other addressable objects.
Explore this clusterOther
492 itemsDocumentation not covered by the other keyword groups in this split.
Explore this clusterAll Text
Add a language and choose its availability
Prepare translations before making a language visible to visitors.
Check or change a site database connection
Verify host, role, database, and schema before restarting a site.
Direct test mail to a controlled recipient
Prevent an acceptance workflow from emailing real users.
Configure and check persistent media storage
Keep original uploads accessible across deployments and restarts.
Configure outbound email and verify delivery
Set a relay at the correct scope and test a real site message.
Run a planned maintenance window
Coordinate changes and verify service before reopening access.
Check that a site is working
Monitor the user-facing service as well as its processes.
Change persistent configuration
Choose the right configuration layer and verify the effective value.
Deploy and verify a release
Apply a tested revision and check the site from a visitor’s perspective.
Diagnose missing or failed email
Trace one message from request to recipient.
Hand over an incident and record recovery
Give the next operator enough context to continue safely.
Set upload sizes and allowed file types
Adjust group upload limits and test with an ordinary account.
Rehearse a complete site restore
Restore into isolation and verify content, media, and access.
Define what a complete backup includes
Choose recovery coverage, retention, and an owner.
Plan and apply an upgrade
Test version-specific changes and establish a recovery point.
Configure media sandboxing and an optional media runner
Check media-process isolation and decide whether to run conversions on a separate service.
Read logs and collect useful evidence
Find the relevant failure without exposing credentials or personal data.
Prepare an acceptance or production environment
Separate environments and record how the site is operated.
Configure service startup and restart behaviour
Run Zotonic under the installation’s service manager.
Enable or disable a site feature
Change module activation and verify the affected workflow.
Diagnose failed uploads or missing media
Locate the failure in permission, storage, or processing.
Prepare and carry out recovery from a failed release
Recover code and data to a compatible state.
Configure hostnames and HTTPS
Align DNS, site selection, and certificate termination.
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.
Diagnose a site that will not start
Separate node, site, database, and application failures.
Review accounts and shared responsibilities
Find obsolete access and verify who can administer the site.
resetratelimit: Reset a site rate limiter
Reset a site rate limiter.
rpc: Call an exported Erlang function on the node
Call an exported Erlang function on the node.
open: Open the site URL in a browser
Open the site URL in a browser.
flush: Flush site caches
Flush site caches.
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.
stop: Stop the Zotonic node
Stop the Zotonic node.
siteconfig: Display a site configuration resolved from files
Display a site configuration resolved from files.
connectdb: Test the configured PostgreSQL connection
Test the configured PostgreSQL connection.
pot: Generate gettext translation template files
Generate gettext translation template files.
wait: Wait until the node answers a ping
Wait until the node answers a ping.
Install on macOS or Linux
Install the native tools, prepare PostgreSQL, and build a local checkout.
Choose the site admin or the status site
Use the right management surface and account.
etop: Inspect active Erlang processes
Inspect active Erlang processes.
dispatch: Inspect dispatch rules or trace a URL
Inspect dispatch rules or trace a URL.
runtests: Run selected core test modules
Run selected core test modules.
Test and publish access rules
Check a rule change before it affects everyone.
start: Start Zotonic in the background
Start Zotonic in the background.
load: Load changed BEAM files
Load changed BEAM files.
debug: Start Zotonic in the foreground with an Erlang shell
Start Zotonic in the foreground with an Erlang shell.
sitedir: Show a site application directory
Show a site application directory.
update: Compile, load, flush, and rescan the server
Compile, load, flush, and rescan the server.
Prepare local PostgreSQL
Create and check the database used by a native development installation.
start_nodaemon: Start Zotonic in the foreground without an interactive shell
Start Zotonic in the foreground without an interactive shell.
Remove access when someone leaves
Remove login methods and permissions without deleting their authored content.
startsite: Start a selected site on the node
Start a selected site on the node.
setconfig: Set a global runtime Zotonic value
Set a global runtime Zotonic value.
sitetest: Run site tests using an isolated test schema
Run site tests using an isolated test schema.
status: Show node and site state
Show node and site state.
stopsite: Stop one site
Stop one site.
configtest: Check whether global configuration files can be read
Check whether global configuration files can be read.
createdb: Prepare a site database and schema
Prepare a site database and schema.
Use the Nix development shell
Enter the supplied OTP 28 development shell, prepare PostgreSQL, and build.
decrypt: Decrypt a local encrypted backup file
Decrypt a local encrypted backup file.
restartsite: Restart one site
Restart one site.
restart: Restart Zotonic and all sites within the current VM
Restart Zotonic and all sites within the current VM.
logtail: Print recent lines from a configured log file
Print recent lines from a configured log file.
Assign user groups and check access
Give an account the permissions required for its work.
backup: List, create, or restore backups
List, create, or restore backups.
Choose a development tool
Start with the symptom and use the smallest tool that explains it.
Reload the browser after source changes
Open System → Development and enable live reload. The page also enables separate CSS and JavaScript files when needed.
Update dependencies deliberately
Change a dependency when you can identify the required fix or feature and the affected callers. Read its version constraints and inspect the resulting lockfile…
addsite: Create a site application from a skeleton
Create a site application from a skeleton.
Check template references
Open Cross-reference check of templates in the Development page and run the check. Read each reported reference with the active module set in mind.
Distinguish stale cache data from stale code
First check which file is selected and whether the changed code compiled. Then repeat the request with the relevant cache disabled or flushed.
Verify an upgrade before release
Prepare an isolated copy of the previously released application and database. Add representative edited content, then apply the new code and schema changes.
Understand the optional development API
The Development page has an option to enable an API for recompiling and rebuilding Zotonic. The model implements actions for recompiling, flushing caches, and…
Inspect template dependencies
Open Dependency graph of all available templates from the Development page. Use the graph to understand inheritance and include relationships before changing a…
Trace database queries for your session
Enable module#mod_server_storage if the Development page says it is needed for database tracing. On the Development page, enable Trace all database queries for…
config: Display configuration resolved from files
Display configuration resolved from files.
Deploy a repeatable release
Record the code revision, build steps, configuration changes, and schema changes for the release. Build and test the same revision in an acceptance environment…
A page is slow
Measure one representative request and identify whether time is spent in the browser, network, or server. Compare an initial request with a repeated request to…
compile: Request recompilation on the running node
Request recompilation on the running node.
A site does not start
Run bin/zotonic status to distinguish an unavailable node from a stopped or failing site. Inspect the relevant startup log before repeatedly restarting it.
An uploaded image does not display
Check whether the resource has an original file and whether its media information describes that file correctly. Then inspect the preview request in the…
Configure persistent file storage
Identify where the site's archive files, generated previews, backups, and security files are stored. These have different retention and recovery needs.
Trace a small number of Erlang calls
Open the Development function tracing tool as the admin user. Enter a module, optionally a function, and a small limit on the number of calls.
chromium: Open a site in Chromium
Open a site in Chromium.
A saved change does not appear
Check each stage in order: the edited file, build output, loaded application, active module, selected template, and browser response.
chrome: Open a site in Chrome
Open a site in Chrome.
Check a rendered template
Render the changed page with realistic content. Include missing optional fields, a long title, several list items, and a second language when applicable.
compilefile: Recompile one Erlang source file
Recompile one Erlang source file.
Verify backups by restoring them
Define what must be recovered: database, original media, configuration, and security material. Check which parts the selected backup includes before depending…
A module is missing from the admin
Check that the module is an Erlang application in a discovered project directory. Confirm the application name, .app.src, main mod_... module, and successful…
Keep development and production settings distinct
Keep development and production settings distinct.
Find registered observers
Open Show an overview of all observers from the Development page. Find the notification and inspect the registered callbacks and their order.
Enable the Development module
Sign in to the local site's admin as an administrator. Open the module management page, find Development (mod_development), and activate it if necessary.
Trace a URL through dispatch
Open the Development page's dispatch tools. Inspect the list of active rules, then trace the path that produces an unexpected result.
A model returns an error or no value
Check the requested path and compare its binary segments with the model callback patterns. Confirm that the callback returns the unused path in the required…
configfiles: List selected global configuration files
List selected global configuration files.
Choose checks for a change
Choose checks for a change.
Find the configuration layer to change
Distinguish global Zotonic configuration, Erlang runtime configuration, site configuration files, and module settings stored for a site. Similar setting names…
Trace templates rendered by a request
Open the Development page's Live dependency graph of templates tool. Start a trace for your session, then load the page or path you want to inspect.