Skip to content

Commit 3354d46

Browse files
committed
docs: refresh multitenancy setup guidance
Update quickstart and installation guidance to call out auto middleware wiring and manual ordering, and note correlation pre-processor cleanup in the overview.
1 parent 591be0d commit 3354d46

File tree

4 files changed

+15
-8
lines changed

4 files changed

+15
-8
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ Quick links:
6363
```
6464
2. Register:
6565
```csharp
66-
services.AddCleanArchitectureMultitenancyAspNetCore();
66+
services.AddCleanArchitectureMultitenancyAspNetCore(autoUseMiddleware: true);
6767
```
68-
3. Add middleware:
68+
3. If you prefer manual wiring, add middleware:
6969
```csharp
7070
app.UseCleanArchitectureMultitenancy();
7171
```

docs/getting-started/installation.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ builder.Services.AddCleanArchitectureMultitenancyAspNetCore();
5050
builder.Services.AddCleanArchitectureMultitenancyEfCore();
5151
```
5252

53+
Tip: pass `autoUseMiddleware: true` to `AddCleanArchitectureMultitenancyAspNetCore` when you cannot modify `Program.cs`.
54+
Prefer manual middleware wiring for claim- or route-based resolution so you can control authentication/routing order.
55+
5356
Add pipeline behaviors in Application:
5457

5558
```csharp

docs/getting-started/quickstart.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,17 @@ dotnet add src/Web/Web.csproj package CleanArchitecture.Extensions.Multitenancy.
4747

4848
```csharp
4949
using CleanArchitecture.Extensions.Multitenancy.AspNetCore;
50-
using CleanArchitecture.Extensions.Multitenancy.AspNetCore.Middleware;
5150

52-
builder.Services.AddCleanArchitectureMultitenancyAspNetCore();
51+
builder.Services.AddCleanArchitectureMultitenancyAspNetCore(autoUseMiddleware: true);
5352

5453
var app = builder.Build();
55-
app.UseCleanArchitectureMultitenancy();
5654
```
5755

56+
If you prefer manual wiring, call `app.UseCleanArchitectureMultitenancy()` instead of enabling `autoUseMiddleware`.
57+
Use manual wiring when you need claim- or route-based resolution so you can place the middleware after authentication or routing.
58+
59+
Template-friendly default: use header or host resolution. Route-based extraction requires routing middleware before the multitenancy middleware.
60+
5861
### 3) Add the multitenancy pipeline behaviors
5962

6063
```csharp

docs/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,8 @@ dotnet add src/Web/Web.csproj package CleanArchitecture.Extensions.Multitenancy.
5151
```csharp
5252
using CleanArchitecture.Extensions.Multitenancy;
5353
using CleanArchitecture.Extensions.Multitenancy.AspNetCore;
54-
using CleanArchitecture.Extensions.Multitenancy.AspNetCore.Middleware;
5554

56-
builder.Services.AddCleanArchitectureMultitenancyAspNetCore();
55+
builder.Services.AddCleanArchitectureMultitenancyAspNetCore(autoUseMiddleware: true);
5756

5857
builder.Services.AddMediatR(cfg =>
5958
{
@@ -63,11 +62,13 @@ builder.Services.AddMediatR(cfg =>
6362
});
6463

6564
var app = builder.Build();
66-
app.UseCleanArchitectureMultitenancy();
6765
```
6866

67+
Use manual middleware wiring when you need claim- or route-based resolution so you can place the middleware after authentication or routing.
68+
6969
If you use MediatR request logging pre-processors (template default), register `AddCleanArchitectureMultitenancyCorrelationPreProcessor` before logging so request logs include tenant context.
7070
In the Jason Taylor template, keep the multitenancy pipeline after authorization behaviors so authorization runs first.
71+
The correlation pre-processor registers a matching post-processor to clean up log scopes.
7172

7273
## Documentation map
7374

0 commit comments

Comments
 (0)