Installation Guide

From MODx Wiki
Jump to: navigation, search

Note

The steps below are for installing MODx Evolution. If you are installing MODx Revolution, look here.

Step by step

  1. Download the latest version of MODx (.zip format for Windows and Mac) and store it in some folder on your computer.
  2. Go to that folder and unzip the downloaded archive file. Generally right-clicking on the archive shows a context menu where you can select Extract here or double click the archive and extract it with the program that opens it.
  3. If you are going to install MODx to a Linux/Unix computer, create a blank file called config.inc.php in the manager/includes/ directory that was included in the MODx archive.
  4. Upload the contents of the extracted folder to the directory on your webserver where you want to run MODx. Usually you will just upload them to your root directory. At this point you need an FTP client to do the uploading with.
  5. If you are installing on to a Linux/Unix computer, you need to CHMOD the following files/folder so that your Apache user has write access to them (can be easily done with a good FTP client). If you don't know what CHMOD rights you should set, try 0666 (rw-rw-rw-). If you get a screen in the installation that tells you that some directories are not writeable by the server, change the CHMOD settings to 0777 (rwxrwxrwx) for the following directories:
    • /assets/cache folder and all files inside it, except index.html
    • /assets/export folder
    • /assets/files folder
    • /assets/flash folder
    • /assets/images folder
    • /assets/media folder
    • /manager/includes/config.inc.php NOTE! The write access must be removed from this file after successful installation. Write down the current read-only CHMOD setting for later use. (usually 0644)
  6. Create a MySQL database on your server for your MODx site to use. This is usually done using the control panel that your web server provider has set up for you, such as Plesk or cPanel. For more information about creating the database using cPanel, visit modxhost tutorial here. Important: Make a note of the database name shown after you create the DB, it may not be what you typed because some hosts modify it.
  7. Create a new database user and associate that user with the database you just created.
    Note: you must set sufficient rights for the user for that database (eg. create table, select, insert, update, delete , etc. Safe bet is to put all rights). Don't forget to write down the user name and password you create! You will need them in the database section during the install process.
  8. Now fire up your web browser and load the index.php file found in the /install/ directory. For example, if you uploaded all the MODx files to the root directory at www.yourdomain.com, you would type http://www.yourdomain.com/install/index.php.
  9. Follow the online steps.
    Note': As you go through the installation guide, there's a page with database connection information. The default Collation is utf8_general_ci, but if your MySQL version is older than 4.1, you have to use cp1251_koi8 as the Connection character set because the the only allowable value for charset_name is cp1251_koi8 before MySQL 4.1. It is possible to add new character set mappings by editing the sql/convert.cc file in the MySQL source distribution though, so you might be possible to use other charsets too.
  10. Once you get to a screen that has a checkbox offering to remove install directory, make sure it's checked, as this prevents people from running the installation process again and doing a hostile take over of your site. With the most recent release- Modx Evolution MODx Evolution 1.0.0 this option is unavailable so you will have to manually remove the install folder via FTP or your file manager.
  11. After the installation, go back to your FTP program and make sure that the /install folder is deleted. If it's not, delete it manually.
  12. Finally, change the permissions of your config.inc.php file in /manager/includes folder back to read only. If you had written it down before, use that same CHMOD setting now, or try setting to 0444 (r--r--r--). This is really important, and will help to prevent your site from being hacked. This is where MODx stores your database name and password, so you MUST control the permissions on this file!
  13. That’s it, you're done. It’s really not that hard.

Possible Issues

Personal tools