Proximity Documentation

Welcome to the Proximity documentation. This covers the main aspects of the project.

Documentation Structure

Getting Started

• Quick Start Guide - Set up Proximity with Docker Compose
• Installation Guide - Detailed installation instructions
• First Steps - Your first deployment

Architecture & Design

• System Architecture - Overall system design and component overview

API Reference

• REST API Documentation - Complete endpoint reference

Development

• Testing Guide - Running and writing tests
• Contributing Guide - Contribution guidelines

Security

• Security Summary - Security audit findings and fixes applied
• Backend Security Audit - Backend security findings
• Frontend Security Audit - Frontend security findings

Key Features

• Proxmox Integration - Deploy and manage LXC containers via the Proxmox API
• Application Catalog - Pre-configured applications ready to deploy
• Backup Management - On-demand backup creation and restoration
• Container Adoption - Discover and import unmanaged LXC containers
• Web UI - SvelteKit-based interface
• REST API - Full API with JWT authentication
• Async Tasks - Celery-based background task processing

Getting Help

• API Documentation - API reference
• GitHub Issues - Report bugs or request features

Known Limitations

• No admin panel UI (user management requires CLI or Django admin)
• No built-in monitoring dashboard (Proxmox metrics are polled per request)
• Scheduled automatic backups are not yet implemented (backups are on-demand)
• Some pages use mock data placeholders (noted in FEATURE_MAPPING_AUDIT.md)