diff --git a/source/docs/configuration.md b/source/docs/configuration.md index 793c7633..e7e3122b 100644 --- a/source/docs/configuration.md +++ b/source/docs/configuration.md @@ -11,7 +11,7 @@ The `config/tenancy.php` file lets you configure how the package behaves. > **Note:** If the `tenancy.php` file doesn't exist in your `config` directory, you can publish it by running `php artisan vendor:publish --provider='Stancl\Tenancy\TenancyServiceProvider' --tag=config` -### `storage_driver, storage` +### `storage_driver, storage` {#storage} This lets you configure the driver for tenant storage, i.e. what will be used to store information about your tenants. You can read more about this on the [Storage Drivers](/docs/storage-drivers) page. @@ -19,33 +19,33 @@ Available storage drivers: - `Stancl\Tenancy\StorageDrivers\RedisStorageDriver` - `Stancl\Tenancy\StorageDrivers\DatabaseStorageDriver` -### `tenant_route_namespace` +### `tenant_route_namespace` {#tenant-route-namespace} Controller namespace used for routes in `routes/tenant.php`. The default value is the same as the namespace for `web.php` routes. -### `exempt_domains` +### `exempt_domains` {#exempt-domains} If a hostname from this array is visited, the `tenant.php` routes won't be registered, letting you use the same routes as in that file. -### `database` +### `database` {#database} The application's default connection will be switched to a new one — `tenant`. This connection will be based on the connection specified in `tenancy.database.based_on`. The database name will be `tenancy.database.prefix + tenant UUID + tenancy.database.suffix`. You can set the suffix to `.sqlite` if you're using sqlite and want the files to be with the `.sqlite` extension. Conversely, you can leave the suffix empty if you're using MySQL, for example. -### `redis` +### `redis` {#redis} If `tenancy.redis.tenancy` is set to true, connections listed in `tenancy.redis.prefixed_connections` will be prefixed with `config('tenancy.redis.prefix_base') . $uuid`. > Note: You need phpredis for multi-tenant Redis. -### `cache` +### `cache` {#cache} The `CacheManager` instance that's resolved when you use the `Cache` or the `cache()` helper will be replaced by `Stancl\Tenancy\CacheManager`. This class automatically uses [tags](https://laravel.com/docs/master/cache#cache-tags). The tag will look like `config('tenancy.cache.tag_base') . $uuid`. If you need to store something in global, non-tenant cache, -### `filesystem` +### `filesystem` {#filesystem} The `storage_path()` will be suffixed with a directory named `config('tenancy.filesystem.suffix_base') . $uuid`. diff --git a/source/docs/creating-tenants.md b/source/docs/creating-tenants.md index 7829c711..0f0e6b1a 100644 --- a/source/docs/creating-tenants.md +++ b/source/docs/creating-tenants.md @@ -7,6 +7,8 @@ section: content # Creating Tenants {#creating-tenants} +> **Make sure your database is correctly [configured](/docs/configuration/#database) before creating tenants.** + To create a tenant, you can use ```php