Improve Readme
This commit is contained in:
41
README.md
41
README.md
@@ -1,58 +1,59 @@
|
||||
Absolutely! Here’s 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
|
||||
• Docker Compose V2
|
||||
• Git installed (git --version)
|
||||
|
||||
⸻
|
||||
----
|
||||
|
||||
🔁 Step-by-Step Installation
|
||||
# 🔁 Step-by-Step Installation
|
||||
|
||||
1. Clone the 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
|
||||
|
||||
```
|
||||
🔐 Note: You’ll be prompted to enter your Gitea credentials (username & password or token) to access the repository.
|
||||
|
||||
⸻
|
||||
----
|
||||
|
||||
2. Navigate to the cloned project
|
||||
|
||||
```bash
|
||||
cd docker-compose-selfhost
|
||||
```
|
||||
|
||||
|
||||
⸻
|
||||
----
|
||||
|
||||
3. Pull the Docker images
|
||||
|
||||
Run:
|
||||
|
||||
```bash
|
||||
docker compose pull
|
||||
```
|
||||
|
||||
|
||||
⸻
|
||||
----
|
||||
|
||||
4. Set pgAdmin data folder permissions
|
||||
|
||||
To ensure pgAdmin can access its persistent storage, run:
|
||||
|
||||
```bash
|
||||
sudo chown -R 5050:5050 ./pgadmin/data
|
||||
```
|
||||
|
||||
----
|
||||
|
||||
⸻
|
||||
|
||||
🚀 Ready to go
|
||||
# 🚀 Ready to go
|
||||
|
||||
Now you’re ready to launch the stack:
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
|
||||
```
|
||||
You can access services like pgAdmin, Postgres, Phoenix ERP, and others after containers are running.
|
||||
|
||||
⸻
|
||||
----
|
||||
Reference in New Issue
Block a user