tenancy-docs/docs/source/v1/creating-tenants.blade.md
Samuel Štancl ae63f30be6 New routes
2019-09-21 22:10:32 +02:00

1 KiB

title description extends section
Creating Tenants Creating tenants with stancl/tenancy — A Laravel multi-database tenancy package that respects your code.. _layouts.documentation content

Creating Tenants

Make sure your database is correctly [configured]({{ $page->link('configuration/#database') }}) 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]({{ $page->link('console-commands/#migrate') }}) automatically. You have to do that yourself.