Skip to content

Commit 8f19fd9

Browse files
committed
improved this based on review
1 parent 0338bd7 commit 8f19fd9

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed
Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
---
2-
display_name: pgAdmin
3-
description: A module to add pgAdmin to your Coder workspace for easy access to PostgreSQL databases.
4-
icon: ../../../../.icons/postgres.svg
5-
maintainer_github: AJ0070
2+
display_name: "pgAdmin"
3+
description: "A web-based interface for managing PostgreSQL databases in your Coder workspace."
4+
icon: "../../../../.icons/postgres.svg"
5+
maintainer_github: "AJ0070"
66
verified: false
7-
tags: [helper, database, postgres, pgadmin]
7+
tags: ["database", "postgres", "pgadmin", "web-ide"]
88
---
99

1010
# pgAdmin
1111

12-
This module adds a pgAdmin app to your Coder workspace, providing a web-based interface for managing PostgreSQL databases.
12+
This module adds a pgAdmin app to your Coder workspace, providing a powerful web-based interface for managing PostgreSQL databases.
13+
14+
It can be served on a Coder subdomain for easy access, or on `localhost` if you prefer to use port-forwarding.
1315

1416
```tf
1517
module "pgadmin" {
@@ -19,3 +21,20 @@ module "pgadmin" {
1921
agent_id = coder_agent.example.id
2022
}
2123
```
24+
25+
# Examples
26+
27+
### Serve on a Localhost Port
28+
29+
To access pgAdmin via `localhost` and a port-forward, set the `subdomain` variable to `false`.
30+
31+
```tf
32+
module "pgadmin" {
33+
count = data.coder_workspace.me.start_count
34+
source = "[registry.coder.com/AJ0070/pgadmin/coder](https://registry.coder.com/AJ0070/pgadmin/coder)"
35+
version = "1.0.0"
36+
agent_id = coder_agent.example.id
37+
subdomain = false
38+
port = 8080 # Optional: specify a custom port
39+
}
40+
```

0 commit comments

Comments
 (0)