aljawad/laravel-multidomain

Laravel App on a subdomains, multi-tenancy setting

v1.1.0 2018-06-24 14:07 UTC

Requires

• laravel/framework: >=5.5.0

MIT

• Giacomo Terreni

• laravel
• domain
• multidomain

README

laravel-multidomain

A Laravel extension for using a laravel application on a multi domain setting

Description

This package allows to use a single laravel installation to work with multiple HTTP domains. There are many cases in which different customers use the same application in terms of code but not in terms of database, storage and configuration. With the use of this package is very simple to get a specific env file, a specific storage path and a specific database for each such a customer.

Documentation

Installation

Add gecche/laravel-multidomain as a requirement to composer.json:

{
    "require": {
        "gecche/laravel-multidomain": "1.1.*"
    }
}

Update your packages with composer update or install with composer install.

You can also add the package using composer require gecche/laravel-multidomain and later specifying the version you want (for now, dev-v1.1.* is your best bet).

This package needs to override a minimal set of Laravel core functions as the detection of the HTTP domain in which the application is running is needed at the very first of the bootstrap process in order to get the specific environment file.

That premise implies that this package needs a bit more of "configuration steps" with respect to a standard laravel package.

The first action to take is to replace the whole Laravel container by modifying the following lines at the very top of the app.php file in the bootstrap folder.

//$app = new Illuminate\Foundation\Application(
$app = new Aljawad\Multidomain\Foundation\Application(
    realpath(__DIR__.'/../')
);

Then update also the two application Kernels (HTTP and CLI).

At the very top of the Kernel.php file in the app\Http folder, do the following changes:

use Aljawad\Multidomain\Foundation\Http\Kernel as HttpKernel;
//use Illuminate\Foundation\Http\Kernel as HttpKernel;

Similarly in the Kernel.php file in the app\Console folder:

use Aljawad\Multidomain\Foundation\Console\Kernel as ConsoleKernel;
#use Illuminate\Foundation\Console\Kernel as ConsoleKernel;

The next step is to override the QueueServiceProvider with the extended one in the $providers array in the app.php file in the config folder:

        //Illuminate\Queue\QueueServiceProvider::class,
        Aljawad\Multidomain\Queue\QueueServiceProvider::class,

Lastly you publish the config file.

php artisan vendor:publish 

This package makes use of the discovery feature. Following the above steps your application will be aware of the HTTP domain in which is running both for HTTP and CLI requests (including queue support).

Usage

This package releases three commands to manage your application HTTP domains.

domain.add command

The main command is the domain:add command which takes as argument the name of the HTTP domain to add to the application. Let us suppose to have two domains site1.com and site2.com sharing the same code.

We simply do:

php artisan domain:add site1.com 

and

php artisan domain:add site2.com 

Above commands simply create two new environemnt files, namely .env.site1.com and .env.site2.com in which you can put all the specific configuration for each site, e.g. databases configuration, cache configuration and each other configuration as for the usual environment file. In addition, within the standard storage folder, two new folders have been created, namely site1_com and site2_com with the same substructure in terms of folders of the main storage one. In particular, the folder structure within the new storage folders can be customized in the domain.php config file.

Distinguishing between HTTP domains

For each HTTP request received by the application, the specific environment file is loaded and the specific storage folder is used. If not specific environment file and/or storage folder has been found, the standard ones are used. The detection of the right HTTP domain is done by using the $_SERVER['SERVER_NAME'] PHP variable.

In order to distinguishing between domains use artisan commands (including queue stuff), each artisan command accepts now a new option domain. E.g.:

php artisan list --domain=site1.com 

domain.remove command

The domain:remove command simply removes the specified HTTP domain from the application by deleting its environment file. The use of the force option, allows to delete also the domain storage folder. E.g.:

php artisan domain:remove site2.com 

domain.update_env command

The domain:update_env command allows to update one or all the environemnt files by passing a json encoded array of data to be added at the end of such files. By using the domain option, only one environment file is updated. With no domain option, the command updates all the environment files, including the standard .env one. The list of domains to be updated is maintained in the domain.php config file. The domain:add and the domain:remove add and remove respectively an entry in the domains array in this file. E.g.:

php artisan domain:update_env --domain_values='{"TOM_DRIVER":"TOMMY"}' 

adds the line TOM_DRIVER=TOMMY to all the found environment files.

Further information

At run-time, the current HTTP domain is maintained in the laravel container and can be accessed by its domain() method added by this package.

Compatibility

v1.1 requires Laravel 5.5+

v1.0 requires Laravel 5.1+ (no longer maintained and not tested versus laravel 5.4, however the usage of the package is the same ad for 1.1)