mirror of
https://github.com/DorkSquadRR/DorkNet.git
synced 2026-10-26 07:28:45 -07:00
Update docs for microservices architecture
This commit is contained in:
@@ -23,7 +23,7 @@ main also auto-detects your install.
|
||||
| **Version key** (sent as `X-DorkNet-Version` header) | `december_2020_12_18` |
|
||||
| **Version plugin** | `DorkNet.Server/Versions/Late2020/Late2020VersionPlugin.cs` |
|
||||
| **Schema** | One EF `Initial` migration; SQLite + Postgres both work |
|
||||
| **Runtime topology** | Standalone `DorkNet.Server`, plus gateway-fronted service slices with monolith fallback |
|
||||
| **Runtime topology** | Gateway-fronted microservices with dedicated service slices and a monolith fallback |
|
||||
| **Diverges from `march-2020-03-10` by** | ~170 files |
|
||||
|
||||
Subsystems present on this branch that the March branch doesn't have:
|
||||
@@ -72,7 +72,7 @@ cd DorkNet
|
||||
| `S3:SecretKey` | `S3__SecretKey` | production | S3 secret key |
|
||||
| `S3:Region` | `S3__Region` | no | defaults to `garage`; use `auto` for R2 |
|
||||
|
||||
**4. Boot:**
|
||||
**4. Boot a local standalone server:**
|
||||
|
||||
```pwsh
|
||||
dotnet run --project DorkNet.Server
|
||||
@@ -84,7 +84,8 @@ categories / playlists, and starts listening. You should see
|
||||
`Application started.` in the log; `curl http://localhost:8080/healthz`
|
||||
returns 200.
|
||||
|
||||
For Docker, Dokploy, and microservices deploy notes, see
|
||||
For the production microservices stack, Docker, and Dokploy deploy
|
||||
notes, see
|
||||
[docs/deploy.md](docs/deploy.md).
|
||||
|
||||
---
|
||||
@@ -199,7 +200,7 @@ Default `0` (off).
|
||||
|
||||
| Folder | Purpose |
|
||||
|---|---|
|
||||
| `DorkNet.Server/` | ASP.NET Core backend (controllers, services, data, hubs, middleware) |
|
||||
| `DorkNet.Server/` | Shared ASP.NET Core controller/service stack, standalone fallback, monolith fallback |
|
||||
| `DorkNet.Models/` | DTOs shared between server and client mod |
|
||||
| `DorkNet.Contracts/` | Shared service names, route ownership, service-map options, and health/probe contracts |
|
||||
| `DorkNet.ServiceDefaults/` | Shared service health, JSON, HTTP client, service identity, and route-guard setup |
|
||||
@@ -207,7 +208,7 @@ Default `0` (off).
|
||||
| `DorkNet.Services.*` | Gateway-fronted service hosts for identity, rooms, notify, content, social, commerce, platform, moderation, and web |
|
||||
| `DorkNet.ClientMod/` | MelonLoader IL2CPP mod — the client patcher |
|
||||
| `tools/` | Installers (`install-melon.ps1`, `install-legacy-client.ps1`, `remove-eac.ps1`), Cloudflare tunnel templates |
|
||||
| `Dockerfile`, `Dockerfile.service`, `docker-compose.microservices*.yml` | Full-server, local microservices, and Dokploy microservices deployment entrypoints |
|
||||
| `Dockerfile`, `Dockerfile.service`, `docker-compose.microservices*.yml` | Standalone fallback image, reusable service image, and local/Dokploy microservices entrypoints |
|
||||
|
||||
See [docs/architecture.md](docs/architecture.md) for the full mental
|
||||
model (project layout, request lifecycle, watch-mirror controller
|
||||
@@ -215,6 +216,7 @@ pattern, where to start contributing).
|
||||
|
||||
### Microservices
|
||||
|
||||
The production topology is the gateway-fronted compose stack.
|
||||
`docker-compose.microservices.yml` starts the gateway, identity, rooms,
|
||||
notify, content, social, commerce, platform, moderation, web, and
|
||||
monolith fallback service hosts plus Compose-managed Postgres and Redis
|
||||
@@ -224,6 +226,7 @@ can route the apex and wildcard hostnames to the gateway without Dokploy
|
||||
domain rows.
|
||||
|
||||
The gateway routes owned host/path slices to the dedicated service hosts.
|
||||
The `web` service owns the apex, `www`, `admin`, and `feed` static hosts.
|
||||
The monolith fallback is still present for unknown route families, so
|
||||
public client URLs remain stable while the split continues.
|
||||
|
||||
@@ -238,8 +241,9 @@ $env:DORKNET_S3_REGION="garage" # or auto for R2
|
||||
docker compose -f docker-compose.microservices.yml up --build
|
||||
```
|
||||
|
||||
For deployment details, including Dokploy env vars and the current
|
||||
monolith-vs-microservices split, see [docs/deploy.md](docs/deploy.md).
|
||||
For deployment details, including Dokploy env vars, Cloudflare Tunnel
|
||||
routing, external Postgres, and S3 setup, see
|
||||
[docs/deploy.md](docs/deploy.md).
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user