Create a comprehensive environment variable guide for configuring the dashboard and MAIA integration

[SimoneBendazzoli93]

Overview

Create a clear, exhaustive guide on how to configure the dashboard with all required environment variables. The guide should focus on variables loaded from .env files (parsed in dashboard/core/settings.py) as well as those referenced through django.settings or os.environ within the dashboard/* submodules. The file to be updated is dashboard/environment.md, which already contains partial documentation—please extend and refine it directly.

Tasks

1. Audit all variables used in dashboard code:
   • Review dashboard/core/settings.py and all dashboard/* modules to list every variable loaded from the environment (either via environ.Env() or os.environ).
   • Cross-check with variables loaded into django.settings and referenced anywhere in the dashboard codebase.
2. Describe each variable:
   • For each variable, provide a description, expected type/values, defaults, and where/how it is used (e.g., authentication, storage, deployment, etc.).
   • Include variables for OAuth/OIDC, MinIO, ArgoCD, DB (MySQL/SQLite), Discord, OpenWebAI, ingress, and any others referenced in code or in dashboard/environment.md.
3. Check MAIA package integration:
   • Identify all functions in the MAIA package (e.g., MAIA/maia_admin.py) called from the dashboard (notably, via e.g., from MAIA.kubernetes_utils import ... in dashboard views).
   • Document any environment variables or configuration fields used by these MAIA functions that are required for dashboard operation or deployment.
4. Update and extend dashboard/environment.md:
   • Add missing variables, clarify descriptions, and provide concrete examples if possible.
   • Organize the guide by logical sections (authentication, storage, deployment, etc.).
   • Clearly distinguish between variables used by the dashboard itself and those required for MAIA or third-party integrations.

References

• The current draft content in dashboard/environment.md.
• Variables and usage in dashboard/core/settings.py and other dashboard/* code.
• MAIA integration points, especially in maia_admin.py.
• Sample variables from dashboard/README.md and Helm deployment scripts.

Acceptance Criteria

• The documentation in dashboard/environment.md is accurate, comprehensive, and easy to follow.
• All necessary environment variables for both dashboard and MAIA usage are included, described, and organized.
• The guide enables a new user to fully configure and deploy the dashboard with all integrations enabled.

---

Related files:

• dashboard/environment.md (to be updated)
• dashboard/core/settings.py (reference)
• MAIA/maia_admin.py, dashboard/apps/home/views.py, and any other dashboard code importing from MAIA

Labels: documentation
Issue type: Task