From 58f243851a66460368a56435b214dd3cba1900ed Mon Sep 17 00:00:00 2001 From: Yuri Lima Date: Tue, 2 Sep 2025 16:22:57 +0200 Subject: [PATCH] Improve ReadMe --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 42 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4b6764b..240b934 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Here’s a clean and readable Markdown version of your installation notes, formatted beautifully: +Absolutely! Here’s the updated, beautifully formatted Markdown installation guide, now including the repo cloning instructions and credential notice: ⸻ @@ -6,15 +6,53 @@ Here’s a clean and readable Markdown version of your installation notes, forma ✅ Minimal Requirements • Docker Compose V2 + • Git installed (git --version) ⸻ -⚠️ Important Setup Step +🔁 Step-by-Step Installation -After pulling or downloading the Docker images, you must set the correct file permissions for pgAdmin to work properly: +1. Clone the repository + +First, clone the self-hosted Docker Compose setup from our private repository: + +git clone https://gitea.phx-erp.de/PHXGMBH/docker-compose-selfhost.git + +🔐 Note: You’ll be prompted to enter your Gitea credentials (username & password or token) to access the repository. + +⸻ + +2. Navigate to the cloned project + +cd docker-compose-selfhost + + +⸻ + +3. Pull the Docker images + +Run: + +docker compose pull + + +⸻ + +4. Set pgAdmin data folder permissions + +To ensure pgAdmin can access its persistent storage, run: sudo chown -R 5050:5050 ./pgadmin/data -This ensures pgAdmin can read/write to the persistent data directory. + +⸻ + +🚀 Ready to go + +Now you’re ready to launch the stack: + +docker compose up -d + +You can access services like pgAdmin, Postgres, Phoenix ERP, and others after containers are running. ⸻ \ No newline at end of file