Skip to content

Commit 7d00fc0

Browse files
committed
docs: add DBeaver setup guide
1 parent 557b35c commit 7d00fc0

File tree

1 file changed

+34
-10
lines changed

1 file changed

+34
-10
lines changed

docs/for-developers.md

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -142,27 +142,51 @@ To add an admin user to the database -- a user with special powers in the app, a
142142
$ docker exec -it colandr-api flask add_admin --name=[NAME] --email=[EMAIL] --password=[PASSWORD]
143143
```
144144

145-
## Database Connection
145+
## Database Access
146146

147-
### Create SSH Tunnel
147+
The production PostgreSQL database is in a **private RDS instance** and must be accessed through the EC2 host.
148148

149-
```
149+
Credentials are stored in **LastPass** under:
150+
**Colandr – Production RDS Access**
151+
152+
---
153+
154+
### Option 1 — Terminal
155+
156+
Create an SSH tunnel:
157+
158+
```bash
150159
ssh -i /path/to/colandr.pem \
151160
-L 5432:colandr-db.carpklcd5jnh.us-east-1.rds.amazonaws.com:5432 \
152161
ubuntu@34.232.91.109
153162
```
154163

155-
### Connect via psql
164+
Then connect:
156165

166+
```bash
167+
psql -h localhost -p 5432 -U colandr -d EviProduction
157168
```
158-
psql -h localhost -p 5432 -U colandr
159-
```
160169

161-
### Connect via GUI
170+
---
171+
172+
### Option 2 — DBeaver
173+
174+
DBeaver can create the SSH tunnel automatically.
175+
176+
**PostgreSQL**
177+
178+
- Host: `colandr-db.carpklcd5jnh.us-east-1.rds.amazonaws.com`
179+
- Port: `5432`
180+
- Database: `colandr`
181+
- Username: `colandr`
182+
183+
**SSH Tunnel**
162184

163-
Host: localhost
164-
Port: 5432
165-
SSL: Disabled
185+
- Host: `34.232.91.109`
186+
- Port: `22`
187+
- User: `ubuntu`
188+
- Auth: Public Key
189+
- Key: `/path/to/colandr.pem`
166190

167191
Credentials are stored in LastPass under:
168192
Colandr – Production RDS Access

0 commit comments

Comments
 (0)