83 lines
1.8 KiB
Markdown
83 lines
1.8 KiB
Markdown
# 📦 Minimal Requirements & Installation Guide
|
||
|
||
----
|
||
|
||
✅ Minimal Requirements
|
||
* Docker Compose V2
|
||
* Git installed (git --version)
|
||
|
||
----
|
||
|
||
# 🔁 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. 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
|
||
docker compose pull
|
||
```
|
||
|
||
|
||
----
|
||
|
||
5. 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
|
||
|
||
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.
|
||
|
||
---- |