docs.modx.comMODX Documentation | MODX Documentation

Jump to main content Jump to doc navigation Menu Search Enter a search term Search English / 2.x English English Русский Russian Nederlands Dutch Español Spanish 3.x 2.x (current) MODX Documentation Last updated Mar 17th, 2021 | Page history | Improve this page | Report an issue In this document: Overview Getting started MODX Revolution Quick Links Other Resources Extras xPDO Quick Links Other Resources Contributor Guide What about MODX Evolution? Open COllective Support the team building MODX with a monthly donation. The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX. Backers Budget $0 per month—let’s make that $500! Learn more Overview ¶ MODX Revolution (Revo) is an easy-to-use Content Management System (CMS) and Application Framework rolled into one. Despite the limitless possibilities that MODX affords you, we think you’ll find it refreshingly intuitive to work with. At every step, MODX strives to deliver Creative Freedom. In addition to this documentation site, the MODX Community is vibrant and always willing to help. Go ahead and ask questions there - you’ll be pleasantly surprised at the responsiveness of the MODX user base. Experienced MODX Professionals and vendor-backed commercial support options are also available, so no matter your needs and requirements - you’re covered. Getting started ¶ This documentation site is a thorough Reference for all things MODX, and also includes Guides and Tutorials to help you get started quickly and easily. Highlights include: The Video Quick-Start Series of tutorials A guide on Making Sites with MODX The Creating a Blog in MODX tutorial If you have a question about this documentation site, want to help make it better, view the source of the documentation and the application on GitHub. All contributions are welcome! MODX Revolution ¶ Revolution is MODX’s flagship CMS and application framework, lovingly called "Revo". If you’re new to MODX, start here. Quick Links ¶ Video Quick-Start Series Installation Guide Making Sites with MODX Other Resources ¶ Get the Latest Release Download Add-ons MODX Community Forum Discussions Bugs & Feature Requests Extras ¶ MODX Extras extend the core functionality of the MODX software. Other CMSs refer to them as "Plugins" or "Modules". Many of the Extras are developed by the MODX core team, while others are by third parties. Although by no means an exhaustive reference, the majority of the most popular Extras are documented here. Download Extras Learn more about installing Extras xPDO ¶ xPDO is the object-relational bridge (ORB) that powers MODX. If you know what that means, or you’re the adventurous type, the following is for you: Quick Links ¶ xPDO 2.x Documentation Homepage Getting Started with xPDO 2.x Other Resources ¶ Get the Latest Release Old Forum Discussions Bugs & Feature Requests Contributor Guide ¶ Love MODX? Learn how to get involved in the Community and contribute to the open source project. Documentation Filing and Discussing Issues Becoming a Contributor Documentation Style Guide What about MODX Evolution? ¶ Evolution is MODX’s classic codebase - the original version released in 2005. As of April 2017 Evolution is officially a separate project, no longer under the wings of MODX. That means Evolution has its own leadership, processes, and community. All information about Evolution, including documentation and extras, can be found at evo.im . Open COllective Support the team building MODX with a monthly donation. The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX. Backers Budget $0 per month—let’s make that $500! Learn moreGetting Started An Overview of MODX Server Requirements Installation Basic Installation Advanced Installation Command Line Installation The Setup Config Xml File Git Installation Troubleshooting Installation MySQL 5.0.51 Servers with mod_security Successful installation, now what? Using Friendly URLs Lighttpd Guide Nginx Server Config Explanation of Directory Structure FAQs & Troubleshooting Glossary of Revolution Terms Maintenance Hardening MODX Revolution Moving Your Site Upgrading MODX Troubleshooting Upgrades Upgrading to 2.8.2 and 2.8.3 (and later) Upgrading to 2.3 Upgrading to 2.2 Upgrading to 2.1 Upgrading from 2.0.5 Upgrading from MODX Evolution Functional Changes from Evolution Legacy removed in 2.1 Upgrading to 2.0.0-rc2 Building Sites Tag Syntax Common Template Tags Date Formats Input Filter Output Filter/Modifiers Custom Output Filter Examples Resources Content Types Custom Resource Classes Static Resource Symlink Using Resource Symlinks Weblink Client-proofing the manager Customizing the Manager Customizing Tabs Form Customization Rules Field Default Field Label Field Visible Move TV to Tab New Tab Tab Title Tab Visible TV Default TV Title TV Visible Profiles Sets Custom Manager Themes Dashboards Assigning to a User Group Creating a Dashboard Widget Managing Your Dashboard Widget Types File HTML Inline PHP Snippet Security (ACLs) Policies ACLs Permissions Administrator Policy Resource Policy PolicyTemplates Resource Groups Roles Security Tutorials Creating a Second Super Admin User Giving a User Manager Access Making Member-Only Pages More on the Anonymous User Group Restricting an Element from Users Troubleshooting Security Resetting a User Password Manually User Groups Users Contexts Using a GatewayManager Plugin Using Virtual Hosts Elements Templates Template Variables Creating a Template Variable Bindings CHUNK Binding DIRECTORY Binding EVAL Binding FILE Binding INHERIT Binding RESOURCE Binding SELECT Binding Template Variable Input Types Template Variable Output Types Date TV Output Type Delimiter TV Output Type HTML Tag TV Output Type Image TV Output Type URL TV Output Type Chunks Snippets Plugins Static Elements Integrating Templates Named Anchor Video Quick-Start Series Internationalisation Add a missing translation Media Sources Adding a Media Source Assigning Media Sources to TVs Media Source Types Media Source Type - File System Media Source Type - S3 Securing a Media Source Creating a Client Media Source Package Management Providers Troubleshooting Properties and Property Sets Sending mail Amazon SES mailtrap.io System Settings access_category_enabled access_context_enabled access_resource_group_enabled allow_duplicate_alias allow_forward_across_contexts allow_manager_login_forgot_password allow_multiple_emails allow_tags_in_post allow_tv_eval anonymous_sessions archive_with auto_check_pkg_updates auto_check_pkg_updates_cache_expire auto_isfolder auto_menuindex automatic_alias automatic_template_assignment base_help_url blocked_minutes cache_action_map cache_alias_map cache_context_settings cache_db cache_db_expires cache_db_session cache_db_session_lifetime cache_default cache_disabled cache_format cache_handler cache_json cache_json_expires cache_lang_js cache_lexicon_topics cache_noncore_lexicon_topics cache_resource cache_resource_clear_partial cache_resource_expires cache_scripts cache_system_settings clear_cache_refresh_trees compress_css compress_js compress_js_groups compress_js_max_files concat_js confirm_navigation container_suffix context_tree_sort context_tree_sort context_tree_sortby context_tree_sortdir cultureKey custom_resource_classes date_timezone debug default_content_type default_context default_duplicate_publish_option default_media_source default_media_source_type default_per_page default_template default_username editor_css_path editor_css_selectors emailsender emailsubject enable_dragdrop enable_gravatar error_log_filename error_log_filepath error_page extension_packages failed_login_attempts fe_editor_lang feed_modx_news feed_modx_news_enabled feed_modx_security feed_modx_security_enabled filemanager_path filemanager_path_relative filemanager_url filemanager_url_relative forgot_login_email...