diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..db4f54b --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +__pycache__/ +*.pyc +*.log +*.sqlite +*.db +*.bak +*.tmp +.env +venv/ +node_modules/ diff --git a/PROJECT_STATE.md b/PROJECT_STATE.md new file mode 100644 index 0000000..fbed36f --- /dev/null +++ b/PROJECT_STATE.md @@ -0,0 +1,182 @@ +# OutsideTheDB — Project State + +Last Updated: 2026-03-08 +Version: v3.2.1 +Project Path: ~/outsidethedb/working + +--- + +# Project Purpose + +OutsideTheDB is a Flask + MariaDB infrastructure administration +application used for host registry, health reporting, and operational +database management. + +It is one of the core administrative tools in the OutsideTheBox +infrastructure ecosystem. + +The project also acts as a foundation/reference for other systems such +as: + +- almaflow +- otb_billing +- future infrastructure automation tools + +--- + +# Current Development Layout + +Workspace: + +~/outsidethedb/working + +Release Archives: + +~/outsidethedb/outsidethedb-vX.Y.Z.zip + +Older release folders may exist for reference. + +--- + +# Current Version + +v3.2.1 + +--- + +# Backend Stack + +Flask +MariaDB + +Service deployment: + +systemd + +Service name: + +db-admin + +--- + +# Current Features + +## Host Registry + +Tracks managed hosts and infrastructure information. + +## Health Dashboard + +Displays runtime information and operational data. + +## Database Backup Button + +Allows mysqldump backup of the database. + +## Footer Status + +Displays: + +- application version +- uptime +- database connection status + +--- + +# Operational Philosophy + +This system is designed to be: + +- self-hosted +- infrastructure aware +- operationally transparent +- version controlled with snapshot archives + +--- + +# Release Method + +Development happens in: + +~/outsidethedb/working + +When stable: + +Create archive: + +outsidethedb-vX.Y.Z.zip + +This archive becomes the release snapshot. + +--- + +# Known Good State + +Current version: + +v3.2.1 + +Working features: + +- host registry +- health dashboard +- MariaDB connectivity +- systemd service operation +- backup functionality + +--- + +# Planned Improvements + +## Health Endpoint Improvements + +The /health route will include: + +- uptime +- load averages +- memory usage +- disk usage +- database connectivity + +## Backup Age Indicator + +Display: + +Last Backup: YYYY-MM-DD (N days) + +## UI Improvements + +Planned interface improvements include: + +- clickable hostname edit links +- improved button layout +- footer status enhancements +- removal of temporary CSS fixes + +--- + +# Restart Instructions + +Restart service: + +sudo systemctl restart db-admin + +Check status: + +sudo systemctl status db-admin --no-pager + +Logs: + +journalctl -u db-admin -n 50 --no-pager + +--- + +# Update Policy + +This file must be updated when: + +- version changes +- major features are added +- deployment layout changes +- operational rules change +- architecture changes