Documentation

Everything you need to deploy, secure, and manage DPlaneOS.

Getting Started

🚀

Installation Guide

INSTALL-SAFETY.md • 3,500 words

Complete guide to installing DPlaneOS with safety features, dry-run mode, and rollback procedures.

  • System requirements
  • Dry-run testing
  • Pre-flight validation
  • Rollback procedures
  • Verification steps
📦

Package Manifest

MANIFEST.txt • Package contents

Complete list of what's included in the DPlaneOS package and what's new in v3.3.1.

  • File structure
  • What's new
  • Security features
  • Installation modes
  • Requirements

Security & Hardening

🌐

Internet Deployment Guide

INTERNET-DEPLOYMENT.md • 7,500 words • CRITICAL

Mandatory reading for internet-facing deployments. Complete security hardening guide.

  • Firewall configuration (UFW)
  • Fail2ban intrusion prevention
  • Nginx HTTPS setup
  • SSL certificates (Let's Encrypt)
  • Security testing
  • Emergency procedures
🔒

Security Quick Reference

SECURITY-QUICK-REF.md • 2,000 words

Quick reference card for security monitoring, testing, and emergency procedures.

  • Attack vectors & mitigations
  • Testing commands
  • Daily/weekly checklists
  • Emergency lockdown
  • Configuration tweaks
🛡️

Security Audit Report

SECURITY-AUDIT.md • Honest assessment

Complete security audit showing what's protected, what's not, and deployment guidance.

  • What was fixed
  • Remaining work
  • Security posture
  • Deployment guidelines
  • Honest limitations
⚠️

Threat Model

THREAT-MODEL.md • Security analysis

Comprehensive threat analysis and attack surface documentation.

  • Attack scenarios
  • Mitigation strategies
  • Trust boundaries
  • Risk assessment

Feature Guides

💾

ZFS Management

Wiki • Storage pools & datasets

Complete guide to ZFS pools, datasets, snapshots, and encryption.

  • Creating pools
  • Managing datasets
  • Snapshots & restore
  • Native encryption
  • Performance tuning
🐳

Docker Management

Wiki • Container deployment

Deploy and manage Docker containers through the web dashboard.

  • Deploying containers
  • Managing services
  • Viewing logs
  • Resource monitoring
🌐

Network Shares

Wiki • SMB & NFS

Creating and managing SMB and NFS network shares.

  • SMB configuration
  • NFS exports
  • User management
  • Quotas & permissions
☁️

Cloud Sync (Rclone)

Wiki • Backup to cloud

Sync data with Google Drive, S3, Backblaze, and 40+ providers.

  • Configuring remotes
  • Sync strategies
  • Scheduling backups
  • Monitoring transfers

Recovery & Troubleshooting

🔧

Recovery Procedures

RECOVERY.md • Emergency recovery

Step-by-step recovery procedures for common failure scenarios.

  • Failed installation
  • Corrupted database
  • Locked out scenarios
  • Restore from backup
🐛

Troubleshooting

Wiki • Common issues

Solutions for common problems and error messages.

  • Installation issues
  • Service failures
  • Network problems
  • Performance issues

API & Development

📡

API Documentation

Wiki • REST API reference

Complete REST API documentation for automation and integration.

  • Authentication
  • Endpoints
  • Request/response formats
  • Error codes
🤝

Contributing Guide

CONTRIBUTING.md • Development

Guidelines for contributing code, reporting issues, and submitting pull requests.

  • Code style
  • Testing requirements
  • Pull request process
  • Issue templates

Community & Support

Need Help?

💬 Discussions

Ask questions, share setups, get help from the community.

Join Discussion →

🐛 Issues

Report bugs, request features, track development.

Report Issue →

📖 Wiki

Community-maintained documentation and guides.

Browse Wiki →

🔒 Security

Report security vulnerabilities privately.

Security Policy →