Skip to content

server

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

server

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
ADMIN_TOOLING_GUIDE.md
ADMIN_TOOLING_GUIDE.md
 
 
BINARY_PROTOCOL_SPEC.md
BINARY_PROTOCOL_SPEC.md
 
 
CLIENT_GUIDE.md
CLIENT_GUIDE.md
 
 
CONFIGURATION_SCHEMA.md
CONFIGURATION_SCHEMA.md
 
 
EVENT_STREAM_MODEL_FINAL.md
EVENT_STREAM_MODEL_FINAL.md
 
 
INSTALLATION.md
INSTALLATION.md
 
 
MULTITENANT_BACKUP_RESTORE_MIGRATION_v1.7.0.md
MULTITENANT_BACKUP_RESTORE_MIGRATION_v1.7.0.md
 
 
MULTITENANT_OPERATIONS_RUNBOOK_v1.7.0.md
MULTITENANT_OPERATIONS_RUNBOOK_v1.7.0.md
 
 
MULTITENANT_SAAS_REFERENCE_v1.7.0.md
MULTITENANT_SAAS_REFERENCE_v1.7.0.md
 
 
MULTITENANT_THREAT_MODEL_v1.7.0.md
MULTITENANT_THREAT_MODEL_v1.7.0.md
 
 
OBSERVABILITY_SETUP_v1.7.0.md
OBSERVABILITY_SETUP_v1.7.0.md
 
 
ODBC_JDBC_STRATEGY.md
ODBC_JDBC_STRATEGY.md
 
 
PG_CATALOG_COVERAGE_v1.7.0.md
PG_CATALOG_COVERAGE_v1.7.0.md
 
 
QUICKSTART.md
QUICKSTART.md
 
 
README.md
README.md
 
 
REST_API.md
REST_API.md
 
 
SECURITY.md
SECURITY.md
 
 
SYSTEM_DATABASES_SECURITY.md
SYSTEM_DATABASES_SECURITY.md
 
 
TOOL_COMPATIBILITY_LIMITATIONS_v1.7.0.md
TOOL_COMPATIBILITY_LIMITATIONS_v1.7.0.md
 
 
TOOL_COMPATIBILITY_MATRIX_v1.7.0.md
TOOL_COMPATIBILITY_MATRIX_v1.7.0.md
 
 

README.md

SharpCoreDB Server Documentation

SharpCoreDB Server turns SharpCoreDB into a real network database server for .NET 10.

Version line: v1.9.0

v1.9.0 highlights

  • gRPC-first server runtime over HTTPS (HTTP/2 + HTTP/3)
  • Multi-database hosting with system-database security model
  • JWT/RBAC baseline with optional mTLS hardening
  • Production operations guidance for health, metrics, and deployment

What Server Mode Means

In server mode, SharpCoreDB runs as a network service instead of an in-process embedded engine:

  • Primary protocol: gRPC over HTTPS (HTTP/2 + HTTP/3)
  • Secondary protocols: HTTPS REST API and WebSocket streaming
  • Security model: TLS 1.2+, JWT, optional mTLS, RBAC
  • Operational model: multi-database hosting, health checks, metrics, connection pooling

Start Here

  • ../FEATURE_MATRIX_v1.9.0.md — package feature coverage
  • QUICKSTART.md — first server startup in minutes
  • INSTALLATION.md — platform-specific installation and service setup
  • CONFIGURATION_SCHEMA.md — full server configuration reference

Installers and Deployment

  • Windows Service: installers/windows/install-service.ps1
  • Linux systemd: installers/linux/install.sh
  • macOS launchd: installers/macos/install.sh
  • Docker: src/SharpCoreDB.Server/docker-compose.yml

For complete production installation instructions, see INSTALLATION.md.

API and Protocols

  • REST_API.md
  • BINARY_PROTOCOL_SPEC.md
  • CLIENT_GUIDE.md

Security and Operations

  • SECURITY.md
  • SYSTEM_DATABASES_SECURITY.md

Eventing and Stream Model

  • EVENT_STREAM_MODEL_FINAL.md

Maintenance Note

Superseded phase plans, kickoff notes, RFC documents, and completion status reports have been removed to keep server documentation focused on current operational guidance. Event sourcing is now available via the SharpCoreDB.EventSourcing package.