Modules

Zotonic comes with a considerable number of modules that add functionality to your website. This section describes all of them. To use a module, you need to activate it first. Some modules come with configuration parameters that you can influence the module’s behaviour with.

mod_menu: Create nested navigation menus for your site.
mod_bootstrap: Adds support for the Twitter Bootstrap CSS / JavaScript framework.
mod_seo_sitemap: Creates a sitemap.xml file for your site, containing links to all publicly accessible pages.
mod_auth2fa
mod_base: mod_base is the base module, which acts as a container module holding most of Zotonic basic dispatch rules, Actions and Module tags.
mod_content_groups
mod_wires: Actions, tags (also known as screen components), and javascript for user interfaces using wires .
mod_authentication: This module contains the main Zotonic authentication mechanism. It contains the logon and logoff controllers, and implements the various hooks as described in…
mod_server_storage: Server side storage for the client (aka browser) and server.
mod_survey: Adds the concept of survey resources: user-definable forms which can be created in the admin interface and filled out by the website’s visitors.
mod_mqtt: MQTT is a machine-to-machine (M2M)/“Internet of Things” connectivity protocol. It was designed as an extremely lightweight publish/subscribe messaging…
mod_filestore: Support for storing uploaded and generated images and documents on external services.
mod_admin: Extending the admin menu See m_admin_menu on how to extend the admin menu.
mod_email_dkim: Signs outgoing e-mails with DomainKeys Identified Mail Signatures ( RFC 6376).
mod_translation: This module provides support for dealing with multiple languages.
mod_import_csv: Module which adds “import CSV” button to the admin status screen.
mod_admin_identity: Provides identity management in the admin - for example the storage of usernames and passwords.
mod_development: Presents various tools for development.
mod_mailinglist: This module implements a mailing list system. You can make as many mailing lists as you like and send any page to any mailing list, including confirm mail and…
mod_admin_modules: Adds support in the admin for activating and deactivating modules.
mod_clamav: Uses clamd to scan all uploaded files for viruses.
mod_l10n: Localization of Zotonic. Provides lookups for country, month, week names.
mod_admin_merge: Adds functonality to merge two pages together into a single page.
mod_backup: mod_backup serves two different purposes: it makes a nightly backup of your files and database, and can also backup/restore individual resource items.
mod_seo: Adds basic search engine optimization to the base templates and provides an admin interface for configuring SEO options and Google Universal Analytics.
mod_export: Provides a generic framework to export resources.
mod_ratelimit: Implements rate limiting for various resources.
mod_oembed: Makes media resources from embeddable URLs through the OEmbed protocol.
mod_comment: Implements a basic commenting system, enabling commenting on resources.
mod_acl_user_groups: This module adds rule-based access control.
mod_ssl_ca: The mod_ssl_ca module adds support for using SSL certificates bought from a Certificate Authority.
mod_ssl_letsencrypt: Request certificates from Let’s Encrypt.
mod_editor_tinymce: Adds wysiwyg tinyMCE editors to the admin.
mod_admin_config: Add support for editing the site’s configuration values, as accessed through m_config.
mod_zotonic_site_management
mod_geoip: Used to map IP addresses to geographical locations.
mod_custom_redirect: Enables redirects from unknown hosts and paths to other locations. The other location can be a known path or another web site.
mod_contact: Implements a basic contact form, which gets emailed to the configuration value mod_contact.email , when submitted.
mod_cron: Provides periodic events.
mod_admin_frontend: Adds editing of resources, menu-trees and collections for non-admin users.
mod_oauth2
mod_admin_category: Add support for editing Categories in the admin, by presenting an editable category tree at http://yoursite.com/admin/category .
mod_logging: Logs messages to the database and adds log views to the admin.
mod_video_embed: This module, if activated, checks the pasted URLs in the create media / page dialog of the admin. It will show an embed option for Youtube and Vimeo URLs. It…
mod_video: Adds support for viewing and handling video medium items.
mod_facebook: The mod_facebook module plugs into the authentication systen to enable Facebook login on your site.
mod_admin_predicate: Add support for editing predicates in the admin, by presenting a list of all defined predicates on http://yoursite.com/admin/predicate .
mod_admin_statistics
mod_signup: This module presents an interface for letting users register themselves.
mod_tkvstore: Simple (type,key)/value store. Stores data in the store with minimal latency and (local) serialization of get/put requests.
mod_media_exif: When uploading a file, this module extracts properties from the uploaded media and sets them in the resource.
mod_search: mod_search implements various ways of searching through the main resource table using m_search.
mod_email_receive: Enables the Zotonic site to receive emails for the site’s users. The user’s email address is username@hostname , where the hostname is the hostname as…
mod_email_relay: Enables the Zotonic site to relay emails for the site’s users to their real email addresses.
mod_email_status: This module tracks for all outgoing email addresses:
mod_artwork: This module contains many useful icons and images.
mod_linkedin: The mod_linkedin module plugs into the authentication systen to enable LinkedIn login on your site.
mod_import_wordpress: Import WordPress .wxr files in your site.
mod_acl_mock: Mocking module for access control during tests.
mod_audio: Adds support for viewing and handling audio medium items.
mod_site_update: This module pulls updates of a site‘s code from a remote version control system. The supported version control systems are git and mercurial.
mod_fileuploader: Upload files using a parallel web worker.
mod_microsoft: Adds logon using the Microsoft identity platform.
mod_syslog
mod_image_edit: Non destructive edits of images.
mod_cookie_consent: Wrap external content in such a way that it is only loaded if the user consented to the inclusion of the content (and subsequent cookies).
mod_copyright

Reference Actions

All Modules

Mocking module for access control during tests.

mod_acl_user_groups

This module adds rule-based access control.

Extending the admin menu See m_admin_menu on how to extend the admin menu.

mod_admin_category

Add support for editing Categories in the admin, by presenting an editable category tree at http://yoursite.com/admin…

mod_admin_config

Add support for editing the site’s configuration values, as accessed through m_config.

mod_admin_frontend

Adds editing of resources, menu-trees and collections for non-admin users.

mod_admin_identity

Provides identity management in the admin - for example the storage of usernames and passwords.

mod_admin_merge

Adds functonality to merge two pages together into a single page.

mod_admin_modules

Adds support in the admin for activating and deactivating modules.

mod_admin_predicate

Add support for editing predicates in the admin, by presenting a list of all defined predicates on http://yoursite.com…

mod_admin_statistics

This module contains many useful icons and images.

Adds support for viewing and handling audio medium items.

mod_authentication

This module contains the main Zotonic authentication mechanism. It contains the logon and logoff controllers, and…

mod_backup serves two different purposes: it makes a nightly backup of your files and database, and can also backup…

mod_base is the base module, which acts as a container module holding most of Zotonic basic dispatch rules, Actions and…

Adds support for the Twitter Bootstrap CSS / JavaScript framework.

Uses clamd to scan all uploaded files for viruses.

Implements a basic commenting system, enabling commenting on resources.

Implements a basic contact form, which gets emailed to the configuration value mod_contact.email , when submitted.

mod_content_groups

mod_cookie_consent

Wrap external content in such a way that it is only loaded if the user consented to the inclusion of the content (and…

Provides periodic events.

mod_custom_redirect

Enables redirects from unknown hosts and paths to other locations. The other location can be a known path or another…

mod_development

Presents various tools for development.

mod_editor_tinymce

Adds wysiwyg tinyMCE editors to the admin.

Signs outgoing e-mails with DomainKeys Identified Mail Signatures ( RFC 6376).

mod_email_receive

Enables the Zotonic site to receive emails for the site’s users. The user’s email address is username@hostname , where…

mod_email_relay

Enables the Zotonic site to relay emails for the site’s users to their real email addresses.

mod_email_status

This module tracks for all outgoing email addresses:

Provides a generic framework to export resources.

The mod_facebook module plugs into the authentication systen to enable Facebook login on your site.

Support for storing uploaded and generated images and documents on external services.

mod_fileuploader

Upload files using a parallel web worker.

Used to map IP addresses to geographical locations.

Non destructive edits of images.

Module which adds “import CSV” button to the admin status screen.

mod_import_wordpress

Import WordPress .wxr files in your site.

Localization of Zotonic. Provides lookups for country, month, week names.

The mod_linkedin module plugs into the authentication systen to enable LinkedIn login on your site.

Logs messages to the database and adds log views to the admin.

mod_mailinglist

This module implements a mailing list system. You can make as many mailing lists as you like and send any page to any…

When uploading a file, this module extracts properties from the uploaded media and sets them in the resource.

Create nested navigation menus for your site.

Adds logon using the Microsoft identity platform.

MQTT is a machine-to-machine (M2M)/“Internet of Things” connectivity protocol. It was designed as an extremely…

Makes media resources from embeddable URLs through the OEmbed protocol.

Implements rate limiting for various resources.

mod_search implements various ways of searching through the main resource table using m_search.

Adds basic search engine optimization to the base templates and provides an admin interface for configuring SEO options…

mod_seo_sitemap

Creates a sitemap.xml file for your site, containing links to all publicly accessible pages.

mod_server_storage

Server side storage for the client (aka browser) and server.

This module presents an interface for letting users register themselves.

mod_site_update

This module pulls updates of a site‘s code from a remote version control system. The supported version control systems…

The mod_ssl_ca module adds support for using SSL certificates bought from a Certificate Authority.

mod_ssl_letsencrypt

Request certificates from Let’s Encrypt.

Adds the concept of survey resources: user-definable forms which can be created in the admin interface and filled out…

Simple (type,key)/value store. Stores data in the store with minimal latency and (local) serialization of get/put…

mod_translation

This module provides support for dealing with multiple languages.

Adds support for viewing and handling video medium items.

mod_video_embed

This module, if activated, checks the pasted URLs in the create media / page dialog of the admin. It will show an embed…

Actions, tags (also known as screen components), and javascript for user interfaces using wires .

mod_zotonic_site_management