Setup Documentation¶
Home → Documentation → Setup
This section contains comprehensive setup and deployment guides for Cesivi Server.
📚 Setup Guides¶
Getting Started¶
| Guide | Description | Time |
|---|---|---|
| Quick Start | Get running in 5 minutes | 5 min |
| Detailed Setup | Comprehensive installation and configuration | 15-30 min |
Deployment Methods¶
| Guide | Description | Best For |
|---|---|---|
| Docker Deployment | Container-based deployment | Production, CI/CD |
Configuration¶
| Guide | Description | Covers |
|---|---|---|
| Configuration Guide | All configuration options | Environment vars, appsettings, MockData, Branch config |
🎯 Which Guide Should I Use?¶
I want to...¶
| Task | Guide |
|---|---|
| Try it out quickly | Quick Start |
| Set up for production | Docker Deployment |
| Understand all config options | Configuration Guide |
| Install from source with all options | Detailed Setup |
| Run multiple instances | Configuration Guide → Multi-Instance |
| Deploy to Docker/Kubernetes | Docker Deployment |
📖 Setup Guide Contents¶
Quick Start Guide¶
- Prerequisites check
- Clone and build (2 minutes)
- Run the server (1 minute)
- Quick test examples (2 minutes)
- Known limitations overview
- Next steps
Detailed Setup Guide¶
- Comprehensive prerequisites
- Installation methods (source, Docker, binary)
- Initial configuration walkthrough
- Verification steps with examples
- Common setup issues and solutions
- Production considerations
Docker Deployment Guide¶
- Docker image building
- Docker Compose setup
- Volume mapping for data persistence
- Environment variable configuration
- Production best practices
- Container health checks
- Troubleshooting containers
Configuration Guide¶
- Environment variables reference
- appsettings.json options
- MockData path configuration
- Branch-based configuration (multi-worktree)
- Port configuration
- SSL/TLS setup
- Multi-instance scenarios
⚡ Quick Reference¶
Installation Commands¶
From Source:
git clone https://github.com/your-org/Cesivi.git
cd Cesivi/Cesivi.Server
dotnet run
Docker:
docker-compose up -d
Verify:
curl http://localhost:5000/_vti_bin/health
Default Ports¶
| Service | Port | Protocol |
|---|---|---|
| HTTP | 5000 | http:// |
| HTTPS | 5001 | https:// |
| Docker | 8080 | http:// |
Key Configuration Files¶
| File | Purpose | Location |
|---|---|---|
appsettings.json |
Server configuration | Cesivi.Server/ |
.env |
Test environment variables | test-scripts/ (not committed) |
.branch-config.json |
Branch-specific ports | Repository root |
docker-compose.yml |
Docker configuration | Repository root |
🔧 Prerequisites Summary¶
| Component | Version | Required? |
|---|---|---|
| .NET SDK | 9.0+ | ✅ Required |
| Docker | Latest | ⭕ Optional (for containers) |
| PowerShell | 7+ | ⭕ Optional (for PnP) |
| Git | Any | ⭕ Optional (for source install) |
🚀 Recommended Path¶
For Developers: 1. Quick Start - Get it running 2. Configuration Guide - Customize for your needs 3. Features Overview - Learn what it can do
For DevOps/Production: 1. Docker Deployment - Set up containers 2. Configuration Guide - Environment-specific config 3. Troubleshooting - Fix issues
For Testing/CI: 1. Quick Start - Basic setup 2. Configuration Guide - Test environment config 3. Usage Examples - Integration patterns
❓ Common Questions¶
How long does setup take?¶
- Quick Start: 5 minutes
- Detailed Setup: 15-30 minutes
- Docker Production: 10-15 minutes
Do I need a real SharePoint server?¶
No! Cesivi Server is completely standalone. No SharePoint, SQL Server, or Windows Server required.
Can I run multiple instances?¶
Yes! See Configuration Guide for multi-instance and multi-worktree setups.
What about data persistence?¶
MockData is stored in ./MockData by default. For Docker, use volume mapping. See Configuration Guide.
Is SSL/HTTPS required?¶
No. HTTP is fine for development. For production, see Docker Deployment for reverse proxy SSL termination.
📞 Need Help?¶
- Issues during setup? → Troubleshooting Guide
- Docker problems? → Docker Troubleshooting
- Configuration questions? → Configuration Guide
- General questions? → Documentation Index
📋 Post-Setup Checklist¶
After setup, verify these items:
- [ ] Server starts without errors
- [ ] Health endpoint responds:
curl http://localhost:5000/_vti_bin/health - [ ] REST API works:
curl http://localhost:5000/_api/web - [ ] MockData directory created
- [ ] Ports accessible (no firewall blocking)
- [ ] For Docker: Container healthy (
docker ps) - [ ] For Docker: Volumes mounted (
docker volume ls)
🎯 Next Steps After Setup¶
- Learn the features → Features Overview
- Try examples → Basic Operations
- Migrate data → Migration Tool Guide
- Extend with plugins → Plugin Guide