diff --git a/README.md b/README.md index 50649cf..39322b4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - # 📦 Minimal Requirements & Installation Guide ---- @@ -28,7 +27,33 @@ cd docker-compose-selfhost ---- -3. Pull the Docker images +3. Edit your environment variables +* Open the .env file and adjust configurations only before the first boot. +#### Most importantly: +```bash +# ====== Phoenix Super Admin Configuration ====== +SUPER_ADMIN_USER_PASSWORD=your-secure-password-here +``` + +#### You can also configure other services like database, pgAdmin, mail server, and Redis in this same .env file. +Example: +```bash +NODE_ENV=production +POSTGRES_PASSWORD="8*6&Ti3TJxN^" +PGADMIN_DEFAULT_EMAIL="info@phx-erp.de" +PGADMIN_DEFAULT_PASSWORD="8*6&Ti3TJxN^" +SUPER_ADMIN_USER_PASSWORD=123 +``` + +⚠️ IMPORTANT: ONE-TIME SETTING ONLY + +🛑 The .env variable SUPER_ADMIN_USER_PASSWORD is only used on the first boot to create the super admin user. + +After the system has been started once: +* Depending on what you changing it can break the system. +* To change the super admin password, use the Phoenix ERP UI directly (under Admin settings). + +4. Pull the Docker images Run: ```bash @@ -38,7 +63,7 @@ docker compose pull ---- -4. Set pgAdmin data folder permissions +5. Set pgAdmin data folder permissions To ensure pgAdmin can access its persistent storage, run: ```bash