Skip to content

Commit a4a5bb4

Browse files
committed
[docs] feat(installation): add troubleshooting section for Docker Compose deployment
1 parent 1eda728 commit a4a5bb4

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

docs/deployment/installation.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,30 @@ docker compose up -d
8484

8585
You can now navigate to [http://localhost:8080](http://localhost:8080/) and log in with the credentials filled in your configuration.
8686

87+
### Troubleshooting
88+
89+
#### PostgreSQL: password authentication failed
90+
91+
92+
This error occurs when the PostgreSQL container cannot authenticate with the credentials provided in your `.env` file.
93+
94+
**Common causes:**
95+
96+
| Cause | Solution |
97+
|:------|:---------|
98+
| `POSTGRES_USER` set to a reserved name (e.g. `admin`) | Use a different username (e.g. `openaev`) |
99+
| Mismatch between `POSTGRES_USER`/`POSTGRES_PASSWORD` and `SPRING_DATASOURCE_USERNAME`/`SPRING_DATASOURCE_PASSWORD` | Ensure both sets of credentials match |
100+
101+
#### Container fails to start
102+
103+
If the OpenAEV container exits immediately after starting:
104+
105+
1. Check the logs: `docker compose logs openaev`
106+
2. Verify all required environment variables are set in your `.env` file
107+
3. Ensure all dependency containers (PostgreSQL, ElasticSearch, RabbitMQ, MinIO) are healthy:
108+
```bash
109+
docker compose ps
110+
87111
## Manual installation
88112

89113
This section provides instructions to install and run a pre-built OpenAEV server with its dependencies. Note that this

0 commit comments

Comments
 (0)