Getting started


Automatic (recommended)

Mac OS X and Linux users can install the platform using a single Composer command:

  1. Run composer create-project joomlatools/platform
  2. Complete the steps
  3. Point your webserver to the web/ directory and access the Joomla administrator at


  1. Clone the git repo - git clone
  2. Run composer install
  3. Create a new database and import the MySQL data in the following order:

    • install/mysql/schema.sql
    • install/mysql/data.sql
    • install/mysql/legacy.sql
  4. Copy .env.example to .env and update environment variables:

    • JOOMLA_DB_NAME - Database name
    • JOOMLA_DB_USER - Database user
    • JOOMLA_DB_PASS - Database password
    • JOOMLA_DB_HOST - Database host
    • JOOMLA_DB_TYPE - Only mysqli is supported
    • JOOMLA_ENV - Set to environment (development, staging, production)
    • JOOMLA_KEY - A 32 character random string
    • JOOMLA_CACHE - [OPTIONAL] True or false to enable or disable caching
    • JOOMLA_DEBUG - [OPTIONAL] True or false to enable or disable debug mode
  5. Access Joomla administrator at and login with both username and password admin.

Joomlatools Console

Our Joomlatools Console also supports the Joomlatools Platform. To install the platform with a single command, add the --repo=platform flag:

joomla site:create joomlatools-platform --repo=platform

Server Configuration

To be able to access your Joomla site at your site vhost document root to /path/to/site/web/.

If you are using shared hosting and/or you are not allowed to change your server Apache vhost configuration directly rename htaccess.txt to .htaccess and modify it use your domain name to set web root or document root to /web.

Need Help?

Let our developers personally assist you. You can ask development related questions in our Support Center. Only for Business or Agency subscribers.

Join 23000+ others and subscribe to our newsletter!