1. Getting Started
      1. Basic Installation
      2. What is MODx
    2. Content Editing
      1. Editing Documents
      2. MODx Tags
        1. Document Variables
      3. Terminology
      4. The Manager
      5. Who Should Read This
    3. Designing
      1. Adding Chunks
      2. Adding MODx Tags
        1. Resource Fields
      3. Adding Snippets
      4. Document Caching
      5. Template Basics
    4. Administration
      1. Friendly URL Solutions
      2. Manager Users
        1. Manager Roles And Groups
        2. Reset your Password - Unblock your User
        3. Why Manager Users, Roles and Groups
      3. Moving Site
      4. Taking sites down for maintenance
      5. Upgrading
      6. Web Users
        1. Creating a Web User
        2. Web User Groups and Document Groups
        3. Why Web Users and Groups
    5. Developer's Guide
      1. API Reference
        1. DBAPI
          1. delete
          2. escape
          3. getInsertId
          4. query
          5. select
          6. update
        2. Document Object
        3. DocumentParser Object
          1. addEventListener
          2. changeWebUserPassword
          3. documentContent
          4. documentGenerated
          5. documentIdentifier
          6. documentListing
          7. documentMethod
          8. documentObject
          9. getAllChildren
          10. getCachePath
          11. getChildIds
          12. getDocumentChildren
          13. getDocumentChildrenTVarOutput
          14. getDocumentChildrenTVars
          15. getLoginUserID
          16. getLoginUserName
          17. getLoginUserType
          18. getManagerPath
          19. getParent
          20. getParentIds
          21. getUserData
          22. hasPermission
          23. isBackend
          24. isFrontend
          25. logEvent
          26. maxParserPasses
          27. minParserPasses
          28. regClientCSS
          29. runSnippet
          30. table_prefix
          31. tstart
          32. webAlert
      2. Chunks
      3. Modules
        1. How to create and run a module from within the Content Manager
        2. Managing module dependencies
        3. Setting up configuration parameters
        4. Writing the module code
      4. Plugins
      5. Snippets
      6. Template Variables
        1. (at) Binding
          1. (at)CHUNK
          2. (at)DIRECTORY
          3. (at)DOCUMENT
          4. (at)EVAL
          5. (at)FILE
          6. (at)INHERIT
          7. (at)SELECT
          8. What are (at) Bindings
        2. Creating a Template Variable
        3. What are Template Variables
        4. Widgets
          1. Misc. Widget
          2. DataGrid Widget
          3. Floater Widget
          4. Hyperlink Widget
          5. Marquee Widget
          6. RichTextBox Widget
          7. Ticker Widget
          8. Viewport Widget
          9. What are Widgets

Taking sites down for maintenance

You may occasionally want to take your site down for maintenance to perform server upgrades or update areas of your site such as templates or third party components and etc. The task of taking your site down or placing it into maintenance mode is simple in MODx.

To take your site down for maintenance:

  1. Open the MODx Manager.
  2. Select the 'Tools' tab and then choose 'Configuration' from the available menu options.
  3. When the Configuration page has loaded, choose the 'Site' tab on the page.
  4. Scroll down to the setting entitled 'Site Status' and choose the 'Offline' option.
  5. Click the 'Save' button.

At this point, your site is now offline and visitors will see the Site Unavailable page - see below for information on how to set this page up. You can easily make the site online again by following the options above but selecting 'Online' in step 4.

Setting a Site Unavailable page

To set your Site Unavailable page, follow these steps:

  1. If you haven't already, create a MODx document that contains the information that you want site visitors to see when the site is offline. When creating this page, set the 'Hide in Menu' option to Yes and make sure the page is published.
  2. Open the MODx Manager.
  3. Select the 'Tools' tab and then choose 'Configuration' from the available menu options.
  4. When the Configuration page has loaded, choose the 'Site' tab on the page.
  5. Scroll down to the setting entitled 'Site Unavailable Page' and enter the ID number of your page in the textbox.
  6. Click the 'Save' button.

Your Site Unavailable page is now setup, ready for action!

Suggest an edit to this page on GitHub (Requires GitHub account. Opens a new window/tab).