Cesivi Server - Usage Guide¶

This section contains practical guides for common operations with Cesivi Server.

I want to...¶

Work with Lists and Items - Create lists and libraries → Basic Operations - Add, update, delete items → Basic Operations - Upload and download files → Basic Operations - Work with folders → Basic Operations

Import Real SharePoint Data - Migrate data from production → Migration Guide - Use the migration tool → Migration Guide - Manual export methods → Migration Guide

Extend Functionality - Create custom plugins → Plugin Guide - Hook into operations → Plugin Guide - Test plugins → Plugin Guide

Backup and Restore - Export storage as ZIP → Export/Import Guide - Import storage from ZIP → Export/Import Guide - Backup strategies → Export/Import Guide

Long-Term Archival - Use Cesivi as a SharePoint archive → SharePoint Archive (PREVIEW) - On-Premises retirement scenario → SharePoint Archive - SharePoint Online local backup → SharePoint Archive

Manage Users and Permissions - Create users and groups → Basic Operations - Set permissions → Permissions Guide

Available Guides¶

Basic Operations ¶

Common CRUD operations with examples in REST, CSOM, and PnP PowerShell: - Creating lists and libraries - List item operations (add, update, delete) - File upload and download - Folder management - User and group operations

Migration ¶

Importing data from real SharePoint environments: - Migration tool usage - Supported SharePoint versions - Migration strategies - Manual export methods - Troubleshooting migration issues

Plugins ¶

Extending Cesivi with custom logic: - Plugin architecture overview - Creating your first plugin - Hook system (BEFORE/AFTER) - Plugin examples - Testing and debugging

Export/Import ¶

Backing up and restoring mock data: - Export entire storage as ZIP - Import from ZIP archives - Backup strategies - Environment migration - Docker integration

SharePoint Archive (PREVIEW)¶

Using Cesivi as a long-term archive of real SharePoint content: - On-Premises retirement: keep SP 2016/2019/SE content live-queryable for years after the source farm is decommissioned - SharePoint Online local backup: self-hosted, fully-offline mirror of an SPO tenant - Reference architecture, current capabilities, and honest gap list - Roadmap to production-ready (P1 priority per 2026-04-29 directive)

Code Examples by Technology¶

REST API¶

# Get web information
curl http://localhost:5000/_api/web

# Get all lists
curl http://localhost:5000/_api/web/lists

# Create a list item
curl -X POST http://localhost:5000/_api/web/lists/getbytitle('Documents')/items \
  -H "Content-Type: application/json" \
  -d '{"__metadata":{"type":"SP.Data.DocumentsItem"},"Title":"New Document"}'

CSOM (C#)¶

using (var context = new ClientContext("http://localhost:5000"))
{
    var web = context.Web;
    context.Load(web);
    context.ExecuteQuery();

    Console.WriteLine($"Web Title: {web.Title}");
}

PnP PowerShell¶

# Connect to mock server
Connect-PnPOnline -Url "http://localhost:5000" -UseWebLogin

# Get web
Get-PnPWeb

# Create list
New-PnPList -Title "MyList" -Template GenericList

# Add item
Add-PnPListItem -List "MyList" -Values @{Title="Item 1"}

Common Workflows¶

Setup a Test Environment¶

Migrate from Production¶

Backup and Restore¶

Extend with Plugins¶

Setup & Configuration - Quick Start Guide - Get started in 5 minutes - Configuration Guide - Server configuration - Docker Guide - Container deployment

Features - API Reference - Complete API documentation - Permissions System - Access control - Remote Event Receivers - Event handling

Troubleshooting - Troubleshooting Guide - Common issues - Known Limitations - Current limitations - Error Codes - Error reference

Support¶

Need help? Check these resources: 1. Troubleshooting Guide - Common issues and solutions 2. API Reference - Detailed API documentation 3. Known Limitations - Current limitations

Navigation: - ← Documentation Home - Project Home

Last Updated: 2025-11-15