Install With Composer

1. # Requirements
2. # Licensing & Use
3. # Install TypeRocket with Composer
4. # 2. Installation Types
5. # 2.1 MU Install
6. # 2.2 Root Install
7. # Updating
8. # Pro Repository - Pro
9. # 1. Install
10. # 1.1 Authorize

#Requirements

Before getting started, be sure your setup supports the TypeRocket system and browser requirements.

Important: Pro users with a Plus or Max license will have access to composer via github for the pro extension. Single site licenses do not have composer access for the pro extension.

#Licensing & Use

Before installing TypeRocket using composer, be aware of the licensing restrictions and our advice on how TypeRocket should be used.

#Install TypeRocket with Composer

Important: Composer 2.4+ is required.

To install TypeRocket using composer, first download composer and install it globally. You can read the full instructions on the composer.org website.

#2. Installation Types

There are two recommended ways to download and install TypeRocket using composer:

1. WordPress MU Plugin install.
2. Root install.

For beginners, the MU install is the fittest place to start.

#2.1 MU Install

From the command line, go to your wordpress/wp-content/mu-plugins folder.

composer create-project --prefer-dist typerocket/typerocket typerocket

Finally, in the root of your WordPress MU plugins folder create a PHP file named typerocket.php and add the following.

<?php
/*
Plugin Name: TypeRocket MU  
Description: MU plugin installation.  
Author: TypeRocket  
Version: 5  
Author URI: http://typerocket.com  
*/
define('TYPEROCKET_MU_INSTALL', '/typerocket/wordpress/');  
require ('typerocket/init.php');

#2.2 Root Install

To install TypeRocket as your root application, create the TypeRocket Pro project in a new location run from the command line.

composer create-project --prefer-dist typerocket/typerocket typerocket
cd typerocket

Next, use the TypeRocket Galaxy CLI root:install command to install WordPress and start your project:

php galaxy root:install {database} {db_username} {db_password}

TypeRocket root install is now complete. You can access the WordPress files from the typerocket/wordpress folder. Finally, Complete the WordPress installation by pointing your servers root web folder to the typerocket/wordpress and then visit your site's web address.

#Root Child Themes

A root install's templates theme can not have child themes; this is a limitation of WordPress, and TypeRocket does not yet provide a solution. However, themes and child themes within the standard WordPress themes setup will work.

#PHP Server

Optionally, if you do not have a web server configured, you can use the built-in TypeRocket PHP server on your local machine to view your WordPress site.

php -S localhost:8888 -t wordpress server.php

In your browser, visit localhost:8888 to view the WordPress install page.

#What Root Install Does

Running root:install will:

• Download WordPress in the wordpress folder where the assets are located.
• Create the wp-config.php file in the main TypeRocket folder.
• Enable TypeRocket's root theme as the default.
• Add require __DIR__ . '/init.php'; to your wp-config.php.

#Deploying A Root Install

When pushing your code to a production server, ensure that you have the correct wp-config.php settings. Note, when rooting TypeRocket wp-config.php is modified and init.php is required after the ABSPATH is defined. This is important to note because you need to require the init.php in wp-config.php for production and not just development.

/** Absolute path to the WordPress directory. */
if ( !defined('ABSPATH') )
    define('ABSPATH', dirname(__FILE__) . '/');

require __DIR__ . '/init.php'; // Include TypeRocket

/** Sets up WordPress vars and included files. */
require_once(ABSPATH . 'wp-settings.php');

#Updating

To update TypeRocket run composer update. This will update all the PHP code and JS/CSS assets.

#Pro Repository -

Pro Only Feature

If you are using TypeRocket Pro and have composer access with your license you can follow these instructions to get typerocket/professional installed.

#1. Install

After you a TypeRocket Pro account run these commands to enable TypeRocket Pro from composer:

composer create-project --prefer-dist typerocket/typerocket typerocket
cd typerocket
composer config repositories.professional '{"type": "composer","url": "https://satis.typerocket.com","only": ["typerocket/professional"]}'
composer require typerocket/professional
php galaxy extension:publish typerocket/professional

#1.1 Authorize

When asked for your Username and Password during the composer install process provide the following:

• Username: Your website host name. Examples: www.example.com, example.local
• Password: Your TypeRocket Pro license key.

If your authentication is not working:

1. You may need to log in to your account and free a site from licenses under "Account > View Licenses > Manage Sites".
2. Your license might be expired.
3. You may need to log in to your account and free a site from licenses.