You're looking at v1 documentation. The current version is v3. You can find the docs for the current version here.

Creating Tenants

Make sure your database is correctly configured before creating tenants.

To create a tenant, you can use

tenant()->create('tenant1.yourapp.com');

Tip: All domains under .localhost are routed to 127.0.0.1 on most operating systems. This is useful for development.

If you want to set some data while creating the tenant, you can pass an array with the data as the second argument:

tenant()->create('tenant2.yourapp.com', [
    'plan' => 'free'
]);

The create method returns an array with tenant information (uuid, domain and whatever else you supplied).

Note: Creating a tenant doesn't run migrations automatically. You have to do that yourself.

Edit on GitHub