SiteDashClient Icon


Powerful MODX monitoring and remote management.

By Mark Hamstra (markh)

SiteDash Client is a companion to the SiteDash service, by modmore.

SiteDash gives you an overview of all your MODX sites, including information about your installed MODX version and installed extras, server details, and key configuration. The SiteDash Client package facilitates the secure communication between SiteDash and your site.

SiteDash can remotely, with just a click or two:

  • Upgrade your MODX core
  • Upgrade third-party extras
  • Analyse your error log

SiteDash also monitors for problems. If it detects something you should know, it sends you an alert via email and the built-in Action Center. Alerts include, for example:

  • Running vulnerable version of MODX or packages
  • Core folder left unprotected
  • Setup folder not removed
  • Disk space usage is approaching the limit
  • Error log is huge

To use the Client, you need to create a SiteDash account first. See plans and pricing here. Next, login, and create a new site in the dashboard. That will provide you with the Site Key that you need to enter when installing the client package.

Mark Hamstra


New in SiteDashClient 1.3.0-rc1

SiteDash Client 1.3.0-rc1

Released on 2019-11-12

New features: - Allow remotely clearing the MODX cache (regular via modCacheManager, and forced by removing directories in core/cache) - Check the size of the session table during refresh, to validate (in dashboard) if garbage collection on sessions is running properly - New endpoint for extended monitoring (CPU/Memory usage/database health; in limited beta)

SiteDash Client 1.2.1-pl

Released on 2019-09-27

  • [security] Prevent the MySQL password from potentially being in the returned message if the database backup fails

SiteDash Client 1.2.0-pl

Released on 2019-09-26

  • Include the site name setting in the refresh response
  • Simplify the response from remote core upgrades; should make the log easier to process in the dashboard
  • Prepare remote core update for future support of updating to nightlies
  • Skip overwriting config.core.php files when upgrading core [#85]
  • Support proxies when downloading MODX [#64]
  • Include database table prefix when refreshing information [#30]
  • Fix incorrect savings percentage shown for compressing backup

SiteDash Client 1.1.2-pl

Released on 2019-09-16

  • Check if the ZipArchive class is available before attempting an upgrade [S20710]
  • Allow configuration of the PHP binary if it can't be automatically located [S20896]
  • Rename incorrectly named interface/classes

SiteDash Client 1.1.1-pl

Released on 2019-04-24

  • Include the DSN (database name and server) in the system information, to allow detecting changes

    SiteDash Client 1.1.0-pl

    Released on 2019-02-27

    • Backups will now be compressed into a zip file to preserve space
    • Return the upgrade logs when checking php executable fails
    • Catch error when creating a new process [S19510]
    • Fix unpacking the MODX zip on servers with NFS [S19512]
    • Fix root files being placed in a deeply nested directory instead of the root [#65]

    SiteDash Client 1.0.2-pl

    Released on 2019-02-25

    • Log the used PHP executable before running the upgrade
    • Log if the PHP executable couldn't be determined and it's falling back to "php"

    SiteDash Client 1.0.1-pl

    Released on 2019-02-22

    • Add check for the procgetstatus function; without it, we can't check the status of the executed command
    • Make sure a failed backup sets the proper response code
    • Prevent fatal error in refresh when the database connection is unavailable

    SiteDash Client 1.0.0-pl

    Released on 2018-12-10

    • Downgrade symfony/process to 3.4.20 to support PHP 5.5.9+
    • Provide the server with the assetsurl to automatically support non-standard assets directories
    • Backup process no longer depends on exec(), instead using procopen (like upgrade) which has some wider server support

    SiteDash Client 1.0.0-rc4

    Released on 2018-11-29

    • Try to automatically find the mysqldump executable before accepting the mysqldumpbinary setting
    • If the php executable can't automatically be determined, use simply php and assume it's available
    • Check if the exec() function is available before trying the backup

    SiteDash Client 1.0.0-rc3

    Released on 2018-11-28

    • Use Symfony/Process to run the setup for better security and stability
    • Increase download timeout from 15 to 90 seconds

    SiteDash Client 1.0.0-rc2

    Released on 2018-11-27

    • Loosen shell escaping to prevent issues with complex passwords not working for the backup
    • Fix incorrect default for sitedashclient.phpbinary setting
    • Fix upgrade on advanced distributions where the core folder has been moved or a custom config key is used

    SiteDash Client 1.0.0-rc1

    Released on 2018-11-27

    • First beta version of upgrading the MODX core!
    • Make sure invalid requests still return a valid JSON response
    • Add file hasher to use for validating upgrades and for keeping an eye on files changing unexpectedly
    • Add backup command to create a local backup of the database and critical files
    • Settings for PHP and mysqldump binaries to use

    SiteDash Client 0.7.0-pl

    Released on 2018-08-02

    • Make sure that packages have their names normalised when being loaded to fix inconsistencies
    • Update default server url to the new domain
    • Now also reports the core path, base url/path and connectors url/path

    SiteDash Client 0.6.0-pl

    Released on 2018-07-24

    • Public release. Can update itself, too!

    SiteDash Client 0.6.0-rc1

    Released on 2018-07-24

    • Implement remote package upgrades
    • Prevent EWARN getting logged to the error log if diskfreespace or disktotalspace is in the disabled functions

    SiteDash Client 0.5.0-pl

    Released on 2018-05-29

    • Add session table health check to refresh
    • Add a repair table command to allow the session table, and others, to be remotely repaired from SiteDash
    • Add a database check that looks at all database tables for their status and used collations
    • Fix the namespace assetspath not being set correctly (even though that's not used anywhere)

    SiteDash Client 0.4.2-pl

    Released on 2018-02-28

    • Fix overwriting authentication on upgrade to 0.4.1 (only for installs from [S16309]

    SiteDash Client 0.4.1-pl

    Released on 2018-02-25

    • Fix "core out of webroot" check causing false negatives.

    SiteDash Client 0.4.0-pl

    Released on 2017-11-22

    • Now supports downloading the error log contents
    • Client Version is now reported to SiteDash so it can detect what features are available

    SiteDash Client 0.3.1-pl

    Released on 2017-09-26

    • Now also includes the core folder if it isn't outside the webroot, so the server can check if it's protected when renamed

    SiteDash Client 0.3.0-pl

    Released on 2017-09-24

    • First packaged build



    November 12, 2019
    Supported Versions
    2.5 – Current

    More from Mark Hamstra


    Manage client and theme settings from a comfortable interface.


    Keeps track of your content and elements.

    CSRF Helper

    Secures your FormIt and Login forms with CSRF tokens.


    ContextRouter is a simple plug-and-play plugin allowing you to use…