refactor(repo): reorganize repository structure for improved navigation and maintainability
Implement comprehensive directory reorganization to improve discoverability,
logical grouping, and separation of concerns across documentation, scripts,
and infrastructure snapshots.
Major Changes:
1. Documentation Reorganization:
- Created start-here-docs/ for onboarding documentation
* Moved QUICK-START.md, START-HERE.md, GIT-SETUP-GUIDE.md
* Moved GIT-QUICK-REFERENCE.md, SCRIPT-USAGE.md, SETUP-COMPLETE.md
- Created troubleshooting/ directory
* Moved BUGFIX-SUMMARY.md for centralized issue resolution
- Created mcp/ directory for Model Context Protocol configurations
* Moved OBSIDIAN-MCP-SETUP.md to mcp/obsidian/
2. Scripts Reorganization:
- Created scripts/crawlers-exporters/ for infrastructure collection
* Moved collect*.sh scripts and collection documentation
* Consolidates Proxmox homelab export tooling
- Created scripts/fixers/ for operational repair scripts
* Moved fix_n8n_db_*.sh scripts
* Isolated scripts with embedded credentials (templates tracked)
- Created scripts/qol/ for quality-of-life utilities
* Moved git-aliases.sh and git-first-commit.sh
3. Infrastructure Snapshots:
- Created disaster-recovery/ for active infrastructure state
* Moved latest homelab-export-20251202-204939/ snapshot
* Contains current VM/CT configurations and system state
- Created archive-homelab/ for historical snapshots
* Moved homelab-export-*.tar.gz archives
* Preserves point-in-time backups for reference
4. Agent Definitions:
- Created sub-agents/ directory
* Added backend-builder.md (development agent)
* Added lab-operator.md (infrastructure operations agent)
* Added librarian.md (git/version control agent)
* Added scribe.md (documentation agent)
5. Updated INDEX.md:
- Reflects new directory structure throughout
- Updated all file path references
- Enhanced navigation with new sections
- Added agent roles documentation
- Updated quick reference commands
6. Security Improvements:
- Updated .gitignore to match reorganized file locations
- Corrected path for scripts/fixers/fix_n8n_db_c_locale.sh exclusion
- Maintained template-based credential management pattern
Infrastructure State Update:
- Latest snapshot: 2025-12-02 20:49:54
- Removed: VM 101 (gitlab), CT 112 (Anytype)
- Added: CT 113 (n8n)
- Total: 9 VMs, 3 Containers
Impact:
- Improved repository navigation and discoverability
- Logical separation of documentation, scripts, and snapshots
- Clearer onboarding path for new users
- Enhanced maintainability through organized structure
- Foundation for multi-agent workflow support
Files changed: 90 files (+935/-349)
- 3 modified, 14 new files, 73 renames/moves
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
97
disaster-recovery/homelab-export-20251202-204939/README.md
Normal file
97
disaster-recovery/homelab-export-20251202-204939/README.md
Normal file
@@ -0,0 +1,97 @@
|
||||
# Homelab Infrastructure Export
|
||||
|
||||
This directory contains a complete snapshot of your Proxmox-based homelab infrastructure, collected automatically via the homelab collection script.
|
||||
|
||||
## Collection Information
|
||||
|
||||
- **Collection Date**: 2025-12-02 20:49:54
|
||||
- **Proxmox Node**: serviceslab
|
||||
- **Collection Level**: full
|
||||
- **Sanitization Applied**: IPs=false, Passwords=true, Tokens=true
|
||||
|
||||
## Directory Structure
|
||||
|
||||
|
||||
|
||||
## Configuration Files
|
||||
|
||||
### Proxmox Core Configurations
|
||||
- - Datacenter-wide settings
|
||||
- - Storage pool definitions
|
||||
- - User and permission configurations
|
||||
- - Cluster-level firewall rules
|
||||
|
||||
### Virtual Machines
|
||||
Each VM configuration is named:
|
||||
Firewall rules (if present):
|
||||
|
||||
### LXC Containers
|
||||
Each container configuration is named:
|
||||
Firewall rules (if present):
|
||||
|
||||
## System Exports
|
||||
|
||||
### System Information
|
||||
- Proxmox version, hostname, kernel info
|
||||
- CPU, memory, and disk information
|
||||
- Network configuration and routing
|
||||
- Installed packages
|
||||
|
||||
### Cluster Information
|
||||
- Cluster status and membership
|
||||
- Resource allocation
|
||||
- Recent tasks
|
||||
|
||||
### Guest Information
|
||||
- List of all VMs and containers
|
||||
- Resource usage and status
|
||||
- JSON exports for programmatic access
|
||||
|
||||
## Security Notes
|
||||
|
||||
This export may contain sensitive information depending on sanitization settings:
|
||||
|
||||
- **Passwords**: true
|
||||
- **API Tokens**: true
|
||||
- **IP Addresses**: false
|
||||
|
||||
**Recommendation**: Store this export securely. Do not commit to public repositories without careful review.
|
||||
|
||||
## Using This Export
|
||||
|
||||
### As Documentation
|
||||
These files serve as a snapshot of your infrastructure at a point in time. Use them for:
|
||||
- Documentation and disaster recovery
|
||||
- Change tracking (diff with previous exports)
|
||||
- Migration planning
|
||||
|
||||
### Infrastructure as Code
|
||||
Use the collected configurations to:
|
||||
- Create Terraform/OpenTofu templates
|
||||
- Build Ansible playbooks
|
||||
- Document network architecture
|
||||
|
||||
### Restoration Reference
|
||||
In a disaster recovery scenario:
|
||||
1. Reinstall Proxmox VE
|
||||
2. Reference storage configuration from
|
||||
3. Reference network setup from
|
||||
4. Recreate VMs/containers using configs in and
|
||||
5. Restore VM disk images from backups
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **Review the SUMMARY.md** for collection statistics
|
||||
2. **Check collection.log** for any warnings or errors
|
||||
3. **Manually add documentation** to the folder
|
||||
4. **Create network diagrams** and place in
|
||||
5. **Version control** this export in a private Git repository
|
||||
6. **Set up regular collections** to track infrastructure changes
|
||||
|
||||
## Collection Script
|
||||
|
||||
This export was created by the Homelab Infrastructure Collection Script.
|
||||
For questions or issues, consult the script documentation.
|
||||
|
||||
---
|
||||
*Generated by homelab-export-script v1.0.0*
|
||||
Reference in New Issue
Block a user