Merge pull request #18 from stancl/tenant-config

[2.x] Tenant config

docs/navigation.php

@@ -76,6 +76,7 @@ return [
             'url'      => 'digging-deeper',
             'children' => [
                 'Tenants'                    => 'tenants',
+                'Tenant Config'              => 'tenant-config',
                 'Middleware Configuration'   => 'middleware-configuration',
                 'Custom Database Names'      => 'custom-database-names',
                 'Filesystem Tenancy'         => 'filesystem-tenancy',

docs/source/v2/https-certificates.blade.md

@@ -5,7 +5,7 @@ extends: _layouts.documentation
 section: content
 ---
 
-# HTTPS certificates
+# HTTPS Certificates
 
 HTTPS certificates are very easy to deal with if you use the `yourclient1.yourapp.com`, `yourclient2.yourapp.com` model. You can use a wildcard HTTPS certificate.
 

docs/source/v2/misc-tips.blade.md

@@ -9,6 +9,8 @@ section: content
 
 ## Tenant Redirect {#tenant-redirect}
 
+> To enable this feature, uncomment the `Stancl\Tenancy\Features\TenantRedirect::class` line in your `tenancy.features` config.
+
 A customer has signed up on your website, you have created a new tenant and now you want to redirect the customer to their website. You can use the `tenant()` method on Redirect, like this:
 
 ```php

docs/source/v2/telescope.blade.md

@@ -7,6 +7,8 @@ section: content
 
 # Telescope Integration
 
+> To enable this feature, uncomment the `Stancl\Tenancy\Features\TelescopeTags::class` line in your `tenancy.features` config.
+
 Requests in Telescope are automatically tagged with the tenant id and domain:
 
 ![Telescope Request with tags](https://i.imgur.com/CEEluYj.png)

docs/source/v2/tenant-config.blade.md

@@ -0,0 +1,34 @@
+---
+title: Tenant Config
+description: Tenant Config
+extends: _layouts.documentation
+section: content
+---
+
+# Tenant Config {#tenant-config}
+
+It's likely you will need to use tenant-specific config in your application. That config could be API keys, things like "products per page" and many other things.
+
+You could just use the [tenant storage]({{ $page->link('tenant-storage') }}) to get these values, but you may still want to use Laravel's `config()` because of:
+- separation of concerns -- if you just write tenancy implementation-agnostic `config('shop.products_per_page')`, you will have a much better time changing tenancy implementations
+- default values -- you may want to use the tenant storage only to override values in your config file
+
+## Enabling the feature
+
+Uncomment the following line in your `tenancy.features` config:
+```php
+// Stancl\Tenancy\Features\TenantConfig::class,
+```
+
+## Configuring the mappings
+
+This feature maps keys in the tenant storage to config keys based on the `tenancy.storage_to_config_map` config.
+
+For example, if your `storage_to_config_map` looked like this:
+```php
+'storage_to_config_map' => [
+    'paypal_api_key' => 'services.paypal.api_key',
+],
+```
+
+the value of `paypal_api_key` in [tenant storage]({{ $page->link('tenant-storage') }}) would be copied to the `services.paypal.api_key` config when tenancy is initialized.