wip

source/docs/tenant-routes.md

@@ -0,0 +1,28 @@
+---
+title: Tenant Routes
+description: Tenant routes with stancl/tenancy — A Laravel multi-database tenancy package that respects your code..
+extends: _layouts.documentation
+section: content
+---
+
+# Tenant Routes {#tenant-routes}
+
+Routes within `routes/tenant.php` will have the `web` middleware group and the `IntializeTenancy` middleware automatically applied on them. This middleware attempts to identify the tenant based on the current hostname. Once the tenant is identified, the database connection, cache, filesystem root paths and, optionally, Redis connection, will be switched.
+
+Just like `routes/web.php`, these routes use the `App\Http\Controllers` namespace.
+
+> If a tenant cannot be identified,  anexception will be thrown. If you want to change this behavior (to a redirect, for example) read the [Middleware Configuration](middleware-configuration) page.
+
+## Exempt routes {#exempt-routes}
+
+Routes outside the `routes/tenant.php` file will not have the tenancy middleware automatically applied on them. You can apply this middleware manually, though.
+
+If you want some of your, say, API routes to be multi-tenant, simply wrap them in a Route group with this middleware:
+
+```php
+use Stancl\Tenancy\Middleware\InitializeTenancy;
+
+Route::middleware(InitializeTenancy::class)->group(function () {
+    // Route::get('/', 'HelloWorld');
+});
+```