Skip to content

Latest commit

 

History

History

README.md

Simple RSync Daemon Documentation

Welcome to the Simple RSync Daemon documentation. This guide will help you understand, configure, and deploy the Simple RSync Daemon effectively.

Product Versions

Simple RSync Daemon is available in three versions, each designed for different deployment scenarios:

🏭 Production Version

License: Apache 2.0 Status: ✅ In Development Target: Small to medium deployments, single-server installations

  • Complete rsync protocol implementation
  • SSL/TLS encryption
  • Basic security features (authentication, ACLs)
  • Multi-format configuration (JSON, YAML, INI)
  • Hot reload configuration
  • Cross-platform support

Documentation: Production Version Documentation

🏢 Enterprise Version

License: BSL 1.1 (Business Source License 1.1) Status: 📋 Planned Target: Large deployments, multi-server environments, enterprise integrations

  • All Production Version features included
  • Web management interface
  • REST API for management
  • SNMP integration
  • Advanced authentication and authorization (RBAC, ACLs)
  • Advanced security (rate limiting, DDoS protection)
  • High availability and clustering
  • Advanced monitoring and observability
  • Plugin architecture

Documentation: Enterprise Version Documentation

🏛️ Datacenter Version

License: BSL 1.1 (Business Source License 1.1) Status: 📋 Planned Target: Large-scale datacenter deployments, cloud environments, multi-site operations

  • All Enterprise Version features included
  • Horizontal scaling support
  • Multi-site synchronization
  • Cloud service integrations
  • Advanced performance optimizations
  • Multi-tenant support
  • Advanced analytics

Documentation: Datacenter Version Documentation


Documentation Structure

📚 Shared Documentation

Common documentation applicable to all versions:

🏭 Production Version Documentation

🏢 Enterprise Version Documentation

🏛️ Datacenter Version Documentation

👨‍💻 Developer Documentation

Documentation for developers and contributors:


Quick Start

Production Version

  1. Install Simple RSync Daemon
  2. Quick Start Guide
  3. Production Configuration
  4. Production Deployment

Enterprise Version

  1. Install Simple RSync Daemon
  2. Enterprise Setup
  3. Management Interface
  4. High Availability

Datacenter Version

  1. Install Simple RSync Daemon
  2. Datacenter Setup
  3. Multi-Site Configuration
  4. Scaling Guide

Version Comparison

Feature Production Enterprise Datacenter
License Apache 2.0 BSL 1.1 BSL 1.1
RSync Protocol ✅ Complete ✅ Complete ✅ Complete
SSL/TLS
Basic Security
Multi-Format Config
Hot Reload
Web Management
REST API
SNMP Integration
Authentication/RBAC ✅ Basic ✅ Advanced ✅ Advanced
Rate Limiting ✅ Basic ✅ Advanced ✅ Advanced
High Availability
Clustering
Horizontal Scaling
Multi-Site Sync
Cloud Integration
Plugin System
Multi-Tenant

Documentation by Topic

Getting Started

Configuration

Deployment

Operations

Security

Performance

Troubleshooting


Contributing to Documentation

We welcome contributions to improve this documentation. Please see our Contributing Guide for details on how to contribute.

Feedback

If you find any issues with the documentation or have suggestions for improvement, please:

  1. Open an issue on GitHub
  2. Submit a pull request with your improvements
  3. Contact us at docs@simpledaemons.com

Last Updated: December 2024 Production Version: In Development Enterprise Version: Planned Datacenter Version: Planned