Cesivi Documentation (User / Administrator)¶
This folder contains documentation for users and administrators of Cesivi.
For developer documentation, see _docs_dev/.
Getting Started¶
| Document | Description |
|---|---|
| START_MOCK_SERVER.md | How to start the Cesivi server |
| CLI_QUICK_START.md | Quick start with the CLI tool |
| CLI_REFERENCE.md | Full CLI command reference |
| CONFIG_TOOL.md | Interactive configuration tool |
| WEBUI_SETUP.md | Setting up the Web UI |
| EXAMPLES.md | Usage examples |
Configuration¶
| Document | Description |
|---|---|
| APPSETTINGS_CONFIGURATION.md | Complete appsettings.json reference |
| BRANCH_CONFIGURATION.md | Branch-specific port/config assignments |
| LOGGING_CONFIGURATION.md | Log levels, sinks, and file paths |
| LOGGING_GUIDE.md | Logging best practices |
| MOCKDATA_CONFIGURATION.md | Mock data generation and YAML configuration |
| GENERATE_DATA_GUIDE.md | Generating sample SharePoint data |
Authentication & Security¶
| Document | Description |
|---|---|
| AUTHENTICATION.md | Authentication overview (all providers) |
| IDENTITY_PROVIDERS.md | Identity provider configuration |
| MULTI-PROVIDER-IDP.md | Multi-provider IDP — operator guide (N OIDC providers, federated identity, login UI, people-picker browse) |
| UPGRADING-MULTI-PROVIDER.md | Upgrading from single-slot to multi-provider config; ExternalLogin backfill; auto-link recovery |
| PEOPLE-PICKER-IDP.md | People-picker fan-out across OIDC providers (Keycloak, Entra, Okta, Authentik) |
| MULTI-TENANT.md | Multi-tenant farm operator guide — enable, provision/lifecycle, isolation, FarmAdmin provenance, limits (C-B / v1.9) |
| central-administration.md | Central Administration operator guide — opt-in CA site collection at an explicit managed path; Mode A (path on existing WA) vs Mode B (dedicated WA); cross-mode isolation (PLAN-1775) |
| NTLM_SETUP.md | NTLM authentication setup |
| OAUTH2_SETUP.md | OAuth2 / OIDC setup |
| PERMISSIONS_GUIDE.md | SharePoint permissions model (role assignments, groups, inheritance) |
| PERMISSIONS.md | Cesivi Deny ACEs & ACL recalculation — Cesivi-specific extension beyond standard SP Allow-only model |
| SECURITY_BEST_PRACTICES.md | Security recommendations |
| SECURITY_HARDENING_GUIDE.md | Hardening for production |
| SECURITY_DEPLOYMENT_CHECKLIST.md | Security checklist for deployments |
Caching¶
| Document | Description |
|---|---|
| GARNET_CACHING.md | Garnet distributed caching (embedded, AOF, cluster, DNS-SRV) |
Storage¶
| Document | Description |
|---|---|
| STORAGE_PROVIDERS.md | Available storage backends (FileSystem, Sqlite, SqlServer, MySql, LiteDb) |
| STORAGE_MIGRATION.md | Migrating between storage providers |
| SQL_SERVER_SETUP.md | SQL Server configuration |
| POSTGRESQL_SETUP.md | PostgreSQL configuration |
Deployment¶
| Document | Description |
|---|---|
| DEPLOYMENT_GUIDE.md | General deployment guide (direct, Docker, IIS) |
| PRODUCTION_DEPLOYMENT_CHECKLIST.md | Pre-deployment checklist |
| PRODUCTION_BEST_PRACTICES.md | Production operation best practices |
| PRODUCTION_READINESS.md | Production readiness assessment |
| MULTI_SERVER_DEPLOYMENT.md | Multi-server / distributed deployment |
| multi-webapp-ops.md | Multi-Web-Application operations runbook — TLS/HTTP hardening, farm scripting (PnP cmdlets), content-database backup/restore, site-collection move/duplicate, load-balancer deployment (BYO nginx/HAProxy, or the cesivi-lb nginx/Caddy config generator — see § Load-balancer deployment) |
| hnsc-guide.md | Host-Named Site Collections — create/convert (both directions), 301 legacy-URL redirect grace period, certificate SAN model, routing precedence (PLAN-1786) |
| KUBERNETES_DEPLOYMENT.md | Kubernetes deployment |
| HELM_CHART_GUIDE.md | Helm chart configuration |
| PERFORMANCE_TUNING_GUIDE.md | Performance tuning and optimization |
Site Hierarchy¶
| Document | Description |
|---|---|
| USER-GUIDE-SITE-COLLECTIONS.md | Site collections and sub-sites — create, configure, list, delete; permission inheritance; REST/CSOM/PnP/SOAP compat reference |
Pages & Web Parts¶
| Document | Description |
|---|---|
| USER-GUIDE-WEBPARTS-AND-WIKI.md | Web parts, web part pages, wiki pages — add/remove/connect, properties editing, sub-web scoping; REST/CSOM/PnP/SOAP compat reference |
Lists and Libraries¶
| Document | Description |
|---|---|
| USER-GUIDE-COLUMNS.md | Site columns + list columns — all 13 types, CRUD flows, REST/CSOM/PnP/SOAP compat reference |
| USER-GUIDE-LIST-ITEMS.md | List items — creating, editing, deleting, filtering; form pages, inline editing |
| USER-GUIDE-VIEWS.md | List views — Standard/Calendar/Gantt/Datasheet types, personal vs shared, sort/filter/group-by, default view, sub-web views, REST/CSOM/PnP/SOAP compat reference |
Integrations¶
| Document | Description |
|---|---|
| onlyoffice-admin.md | OnlyOffice in-browser document editing — enabling, JWT rotation, 20-connection cap, kill switch, troubleshooting |
Multilingual¶
| Document | Description |
|---|---|
| MULTILINGUAL.md | Multilingual resources — {{t:key}} placeholders, runtime-configurable translations for list titles/view names/web part headers, REST API, five-step resolver fallback chain |
Search¶
| Document | Description |
|---|---|
| USER-GUIDE-SEARCH.md | Search — KQL syntax, all URL shapes (Classic/Modern/REST/SOAP/CSOM), refiners, sub-web scoping, security trimming, search administration, API compat reference |
Real-Time Features¶
| Document | Description |
|---|---|
| REAL-TIME-UPDATES.md | SignalR-based real-time change notifications — AllItems auto-refresh for concurrent users |
User Preferences¶
| Document | Description |
|---|---|
| USER-PREFERENCES.md | Per-user UI preferences (density, language, date/time format, default list view) — what's persisted, how to change, how to reset |
API & Protocol Guides¶
| Document | Description |
|---|---|
| API_REFERENCE.md | REST API endpoint reference |
| ODATA_QUERY_GUIDE.md | OData query syntax ($filter, $select, $expand) |
| URL_CONTRACT.md | URL routing contract — WebUI/YARP proxy topology, same-origin route table, port exposure rules |
| CSOM_GUIDE.md | CSOM client usage guide |
| PNP_GUIDE.md | PnP PowerShell usage guide |
| PNP_COMPATIBILITY.md | PnP PowerShell compatibility matrix |
| KENAFLOW_GUIDE.md | Kenaflow workflow integration |
PowerShell¶
| Document | Description |
|---|---|
| POWERSHELL_CMDLETS.md | PowerShell cmdlet reference (171 cmdlets) |
| POWERSHELL_EXAMPLES.md | PowerShell usage examples |
| POWERSHELL_MIGRATION_GUIDE.md | Migrating from real SharePoint to Cesivi |
| POWERSHELL_TROUBLESHOOTING.md | PowerShell troubleshooting |
Extensibility¶
| Document | Description |
|---|---|
| EXTENSIBILITY_GUIDE.md | Plugin and extension system |
| CLI_EXTENSION_MANAGEMENT.md | Managing extensions via CLI |
| PLUGIN_GUIDE.md | Writing plugins |
| PLUGIN_QUICK_START.md | Plugin quick start |
| SOLUTION-PACKAGES.md | CSP solution packages — creating web parts and extensions (ZIP-based format) |
Migration & Identity¶
| Document | Description |
|---|---|
| MIGRATION_GUIDE.md | Data migration guide |
| MIGRATION_TUTORIAL.md | Step-by-step migration tutorial |
| EXPORT_IMPORT_GUIDE.md | Export/import operations |
| IDENTITY-MAPPING.md | Identity Mapping Bridge — operator guide (when to use, quickstart, deployment checklist, troubleshooting, day-2 ops) |
| IDENTITY-MAPPING-REFERENCE.md | Identity Mapping Bridge — operator reference (script authoring, sandbox, configuration, error handling) |
Archive (v1.2) — SharePoint On-Premises Retirement Archive¶
| Document | Description |
|---|---|
| tutorials/TUTORIAL_G_ARCHIVE_ONPREM_RETIREMENT.md | Start here — step-by-step tutorial: install → import → retention + hold → integrity → ControlCenter tour |
| whitepapers/CESIVI_ARCHIVE_VARIANT_A.md | Customer whitepaper — problem statement, architecture, comparison table, TCO, v1.3+ roadmap |
| compliance/COMPLIANCE_COOKBOOK.md | Compliance Cookbook — HIPAA, GDPR, SOX, FRCP 37(e) citation tables + worked examples |
| ARCHIVE_MODE.md | Archive Mode — retire a web or list to read-only; write rejection, UI banner, admin override, audit trail |
| ARCHIVE_IMPORTER.md | Archive Importer — MigrationTool archive-import operator guide |
| ARCHIVE_IDENTITY.md | Archive Identity Resolution — historical user/group identity mapping (snapshot tier) |
| ARCHIVE_AUDIT.md | Archive Audit Log — WORM substrate, tamper-resistant JSONL hash-chain event trail |
| ARCHIVE_INTEGRITY.md | Archive Integrity Verification — SHA-256 walk, quarantine, on-access gate, runbook |
| ARCHIVE_RETENTION.md | Archive Retention Enforcement — hard retention gate, no admin bypass; HIPAA/GDPR/SOX mapping |
| ARCHIVE_LEGAL_HOLD.md | Archive Legal Hold — hold beats retention; eDiscovery chain of custody; FRCP 37(e) |
| ARCHIVE_CONTROLCENTER.md | Archive Admin Bundle — ControlCenter quick tour (7-card KPI dashboard + 7 sub-pages) |
| ARCHIVE_TOOLS_OPERATOR.md | Archive Tools Operator Guide — StorageBrowser, StorageConverter, Setup wizard |
| STORAGE_BROWSER.md | StorageBrowser — read-only archive metadata tree (ARCHIVED badge, hold lock, integrity pill, retention countdown) |
| STORAGE_CONVERTER.md | StorageConverter — lossless backend migration preserving all 7 archive substores |
| SETUP_WIZARD.md | Setup Wizard — installer wizard with Archive Mode branch (WORM backend + retention defaults + federation) |
| ARCHIVE_CLUSTER.md | Archive Cluster Deployment Guide — two-node HA cluster: shared DataRoot, Garnet config, leader-only services, observability checklist, operator runbook |
Operations & Monitoring¶
| Document | Description |
|---|---|
| OBSERVABILITY_GUIDE.md | Metrics, tracing, health checks |
| SLO_DEFINITIONS.md | Service level objectives |
| INCIDENT_RESPONSE.md | Incident response runbook |
| CAPACITY-LIMITS.md | Capacity limits — items/list, files/library, file size, concurrent users (PLAN-971 benchmarks) |
| TROUBLESHOOTING.md | General troubleshooting |
| KNOWN_LIMITATIONS.md | Known limitations and workarounds |
Subdirectories¶
| Directory | Description |
|---|---|
| setup/ | Setup guides (Quick Start, Docker, Configuration) |
| features/ | Feature documentation (REST, CSOM, PnP, Search, SOAP) |
| reference/ | Technical reference (API coverage, error codes, architecture) |
| tutorials/ | Step-by-step tutorials for common deployment scenarios |
| usage/ | Usage guides (operations, plugins, migration, storage) |
| troubleshooting/ | Troubleshooting by topic (Docker, migration tool) |
| api/ | Auto-generated API documentation |