e41ecfad4c
Include Loyalty/Communication/Sports Center backends and registry updates alongside production nginx and compose wiring. Co-authored-by: Cursor <cursoragent@cursor.com>
138 lines
4.2 KiB
Markdown
138 lines
4.2 KiB
Markdown
# Provider Registry
|
|
|
|
Inventory of external providers. Template: [provider-template.md](templates/provider-template.md). Detail sheets: [provider-reference.md](reference/provider-reference.md).
|
|
|
|
---
|
|
|
|
## Payamak (پاینامک / Payamak-Panel)
|
|
|
|
| Field | Value |
|
|
| --- | --- |
|
|
| Provider Name | Payamak |
|
|
| Country | IR |
|
|
| Capabilities | SMS OTP send; SMS messaging via Communication adapters |
|
|
| Version | API as configured via env / tenant credentials |
|
|
| Dependencies | Network egress to Payamak API |
|
|
| Supported Modules | Core (auth OTP), Identity (via Core OTP client), Communication (platform SMS) |
|
|
| Configuration | Core: `PAYAMAK_*`; Communication: tenant `provider_configs.credentials` |
|
|
| API | Provider HTTP SendOtp / SendSimpleSMS |
|
|
| Status | Active |
|
|
| Documentation | [provider-reference.md](reference/provider-reference.md#payamak), [communication-phase-8.md](communication-phase-8.md) |
|
|
| Tests | Core OTP tests; Communication provider/SMS tests |
|
|
|
|
---
|
|
|
|
## Communication Mock SMS
|
|
|
|
| Field | Value |
|
|
| --- | --- |
|
|
| Provider Name | Mock SMS |
|
|
| Country | N/A |
|
|
| Capabilities | Deterministic SMS send for tests/dev |
|
|
| Version | Built-in |
|
|
| Dependencies | None |
|
|
| Supported Modules | Communication |
|
|
| Configuration | `provider_kind=mock` |
|
|
| API | In-process adapter |
|
|
| Status | Active |
|
|
| Documentation | [communication-phase-8.md](communication-phase-8.md) |
|
|
| Tests | Communication provider/failover tests |
|
|
|
|
---
|
|
|
|
## Keycloak
|
|
|
|
| Field | Value |
|
|
| --- | --- |
|
|
| Provider Name | Keycloak |
|
|
| Country | N/A (self-hosted) |
|
|
| Capabilities | OIDC IdP, realm users/roles, themed login |
|
|
| Version | As deployed in compose/production |
|
|
| Dependencies | Postgres (Keycloak DB), HTTPS public URL |
|
|
| Supported Modules | Identity & Access, Frontend SSO, all JWT-validating services |
|
|
| Configuration | `KEYCLOAK_*`, realm `superapp`, theme `torbatyar` |
|
|
| API | OIDC + Admin API |
|
|
| Status | Active |
|
|
| Documentation | [identity-architecture.md](architecture/identity-architecture.md) |
|
|
| Tests | Identity service tests + manual SSO flows |
|
|
|
|
---
|
|
|
|
## Let's Encrypt / Certbot
|
|
|
|
| Field | Value |
|
|
| --- | --- |
|
|
| Provider Name | Let's Encrypt |
|
|
| Country | N/A |
|
|
| Capabilities | Public TLS certificates |
|
|
| Version | Certbot on edge host |
|
|
| Dependencies | Port 80 ACME, DNS pointing to edge |
|
|
| Supported Modules | Edge / all public hosts, tenant SSL expansion |
|
|
| Configuration | Nginx + `provision_ssl.py` + `SSL_PROVISION_*` |
|
|
| API | ACME |
|
|
| Status | Active |
|
|
| Documentation | [ssl.md](deployment/ssl.md) |
|
|
| Tests | Operational verification scripts |
|
|
|
|
---
|
|
|
|
## S3-Compatible Object Storage (planned)
|
|
|
|
| Field | Value |
|
|
| --- | --- |
|
|
| Provider Name | S3-Compatible |
|
|
| Country | N/A |
|
|
| Capabilities | Object upload/download, tenant-scoped buckets/prefixes |
|
|
| Version | TBD |
|
|
| Dependencies | File Storage module |
|
|
| Supported Modules | file_storage, website_builder, ecommerce media |
|
|
| Configuration | Endpoint, keys, bucket (TBD) |
|
|
| API | S3 API |
|
|
| Status | Planned |
|
|
| Documentation | [phases/Future](phases/Future/README.md) |
|
|
| Tests | TBD |
|
|
|
|
---
|
|
|
|
## Payment Gateway (planned)
|
|
|
|
| Field | Value |
|
|
| --- | --- |
|
|
| Provider Name | TBD (Iranian PSP) |
|
|
| Country | IR |
|
|
| Capabilities | Checkout, refunds, webhooks |
|
|
| Version | TBD |
|
|
| Dependencies | Subscription billing, ecommerce/restaurant payments |
|
|
| Supported Modules | Core subscriptions, ecommerce, restaurant |
|
|
| Configuration | TBD |
|
|
| API | TBD |
|
|
| Status | Planned |
|
|
| Documentation | [roadmap.md](roadmap.md) |
|
|
| Tests | TBD |
|
|
|
|
---
|
|
|
|
## AI Model Provider (planned)
|
|
|
|
| Field | Value |
|
|
| --- | --- |
|
|
| Provider Name | TBD |
|
|
| Country | TBD |
|
|
| Capabilities | Chat/completion, embeddings |
|
|
| Version | TBD |
|
|
| Dependencies | ai_assistant module |
|
|
| Supported Modules | ai_assistant, live_chat assist |
|
|
| Configuration | API keys, model ids |
|
|
| API | Provider SDK/HTTP |
|
|
| Status | Planned |
|
|
| Documentation | [ai-architecture.md](architecture/ai-architecture.md) |
|
|
| Tests | TBD |
|
|
|
|
---
|
|
|
|
## Related Documents
|
|
|
|
- [Integration Architecture](architecture/integration-architecture.md)
|
|
- [Provider Reference](reference/provider-reference.md)
|
|
- [Module Registry](module-registry.md)
|