Improve Readme

This commit is contained in:
2025-09-02 14:27:21 +00:00
parent 58f243851a
commit a597655be9

View File

@@ -1,58 +1,59 @@
Absolutely! Heres the updated, beautifully formatted Markdown installation guide, now including the repo cloning instructions and credential notice:
📦 Minimal Requirements & Installation Guide # 📦 Minimal Requirements & Installation Guide
----
✅ Minimal Requirements ✅ Minimal Requirements
• Docker Compose V2 • Docker Compose V2
• Git installed (git --version) • Git installed (git --version)
----
🔁 Step-by-Step Installation # 🔁 Step-by-Step Installation
1. Clone the repository 1. Clone the repository
First, clone the self-hosted Docker Compose setup from our private repository: First, clone the self-hosted Docker Compose setup from our private repository:
```bash
git clone https://gitea.phx-erp.de/PHXGMBH/docker-compose-selfhost.git git clone https://gitea.phx-erp.de/PHXGMBH/docker-compose-selfhost.git
```
🔐 Note: Youll be prompted to enter your Gitea credentials (username & password or token) to access the repository. 🔐 Note: Youll be prompted to enter your Gitea credentials (username & password or token) to access the repository.
----
2. Navigate to the cloned project 2. Navigate to the cloned project
```bash
cd docker-compose-selfhost cd docker-compose-selfhost
```
----
3. Pull the Docker images 3. Pull the Docker images
Run: Run:
```bash
docker compose pull docker compose pull
```
----
4. Set pgAdmin data folder permissions 4. Set pgAdmin data folder permissions
To ensure pgAdmin can access its persistent storage, run: To ensure pgAdmin can access its persistent storage, run:
```bash
sudo chown -R 5050:5050 ./pgadmin/data sudo chown -R 5050:5050 ./pgadmin/data
```
----
# 🚀 Ready to go
🚀 Ready to go
Now youre ready to launch the stack: Now youre ready to launch the stack:
```bash
docker compose up -d docker compose up -d
```
You can access services like pgAdmin, Postgres, Phoenix ERP, and others after containers are running. You can access services like pgAdmin, Postgres, Phoenix ERP, and others after containers are running.
----