Skip to content

Commit 5ac0438

Browse files
NikolaySclaude
andcommitted
docs: Update README and fix pgwatch-postgres configuration
Changes: - Added Environment Configuration section to README explaining .env usage - Updated Access points section with correct default credentials - Fixed pgwatch-postgres command to use simple array format with docker-compose variable substitution instead of shell interpolation - Added create_issues.sh script for issue management Testing: - All services start successfully with default environment variables - Grafana accessible at localhost:3000 (monitor/changeme) - Prometheus collecting metrics from pgwatch - PostgreSQL databases initialized with correct credentials - pgwatch-postgres now connects successfully to sink database Related to MR !56 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 7dcd5e6 commit 5ac0438

File tree

3 files changed

+475
-13
lines changed

3 files changed

+475
-13
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,29 @@ Experience the full monitoring solution: **https://demo.postgres.ai** (login: `d
6363
- Supports Postgres versions 14-18
6464
- **pg_stat_statements extension must be created** for the DB used for connection
6565

66+
## 🔐 Environment Configuration
67+
68+
**Important:** As of v2.0, all credentials are managed via environment variables for security.
69+
70+
**For demo/development (quickstart handles this automatically):**
71+
```bash
72+
./postgres_ai quickstart --demo # Uses secure defaults
73+
```
74+
75+
**For production deployments:**
76+
```bash
77+
# 1. Copy environment template
78+
cp .env.example .env
79+
80+
# 2. Edit with your secure passwords
81+
nano .env
82+
83+
# 3. Start services
84+
./postgres_ai quickstart --api-key=your_key
85+
```
86+
87+
📖 **See [SECURITY_SETUP.md](SECURITY_SETUP.md)** for complete environment variable documentation, security best practices, and production deployment guidelines.
88+
6689
## ⚠️ Security Notice
6790

6891
**WARNING: Security is your responsibility!**
@@ -190,10 +213,10 @@ Get a complete monitoring setup with demo data in under 2 minutes.
190213

191214
After running quickstart:
192215

193-
- **🚀 MAIN: Grafana Dashboard**: http://localhost:3000 (login: `monitoring`; password is shown at the end of quickstart)
216+
- **🚀 MAIN: Grafana Dashboard**: http://localhost:3000 (login: `monitor`; password shown at end of quickstart, or from `GF_SECURITY_ADMIN_PASSWORD` in `.env`)
194217

195218
Technical URLs (for advanced users):
196-
- **Demo DB**: postgresql://postgres:postgres@localhost:55432/target_database
219+
- **Demo DB**: postgresql://postgres:changeme@localhost:55432/target_database (credentials from `.env` if configured)
197220
- **Monitoring**: http://localhost:58080 (PGWatch)
198221
- **Metrics**: http://localhost:59090 (Prometheus)
199222

0 commit comments

Comments
 (0)