Building core

Last updated Feb 27th, 2021 | Page history | Improve this page | Report an issue

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

Building the core is necessary when a change affects the (default) installation. It is the process by which core/packages/core.transport.zip is created, which is used by the setup.

Preparation¶

When running the build for the first time, you need to prepare some files, first.

Copy the file _build/build.config.sample.php to _build/build.config.php.

Copy the file _build/build.properties.sample.php to _build/build.properties.php.

Only copy the files - you do not typically have to make any changes to them.

Running the build¶

To run the build, you'll need to execute the _build/transport.core.php file. This process typically takes anywhere from 5 to 30 seconds.

You can open the file in the browser, or ideally run it from the commandline:

php _build/transport.core.php

Run setup¶

With the new core package generated, go through the setup process in the browser.