feat(pgadmin): add new module for pgAdmin #228

AJ0070 · 2025-07-12T14:28:38Z

Closes #36

Description

This pull request introduces a new Coder module for pgAdmin. This module allows users to easily add a pgAdmin web interface to their workspaces for managing PostgreSQL databases.

The pgAdmin module under the AJ0070 namespace.
A main.tf file to define the Coder app and script resources.
A run.sh script to handle the installation and launch of pgAdmin.
A README.md with usage instructions and prerequisites.
A basic test file main.test.ts to ensure the module loads correctly.

Type of Change

Module Information

Path: registry/AJ0070/modules/pgadmin
New version: v1.0.0
Breaking change: [ ] Yes [x] No

Testing & Validation

Tests pass (bun test)
Code formatted (bun run fmt)
Changes tested locally

/claim #36

registry/AJ0070/modules/pgadmin/main.tf

registry/AJ0070/modules/pgadmin/README.md

DevelopmentCats · 2025-07-16T18:10:10Z

@AJ0070

I went to test this module. It was having issues with installation, and the app was not being proxied.

I forked the registry and made a branch to see if I can understand what is going wrong here.

The main things that I changed on my side to get this working, was I introduced a variable for the pgadmin config, introduced locals to do joins and formatting, and I utilized the venv for pgadmin.

I then added a step to write the configuration to a file so that pgadmin loads with the ideal settings for coder.

Here is the fork if you would like to take a look. https://github.com/DevelopmentCats/registry/tree/cat/AJ0070-pgadmin-fix/registry/AJ0070

AJ0070 · 2025-07-16T18:13:28Z

@AJ0070

I went to test this module. It was having issues with installation, and the app was not being proxied.

I forked the registry and made a branch to see if I can understand what is going wrong here.

The main things that I changed on my side to get this working, was I introduced a variable for the pgadmin config, and introduced locals to format the url and healthcheck.

I then added a step to write the configuration to a file so that pgadmin loads with the ideal settings for coder.

Here is the fork if you would like to take a look. https://github.com/DevelopmentCats/registry/tree/cat/AJ0070-pgadmin-fix/registry/AJ0070

Thanks for the details!
I'll look into this

AJ0070 · 2025-07-17T02:12:24Z

Thank you so much for taking the time to test the module and provide such detailed feedback. I really appreciate you forking the repository and creating a working example it was incredibly helpful for understanding the issues with installation and proxying.
Your solution is much more stable. With your permission, I would love to incorporate the changes from your cat/AJ0070-pgadmin-fix branch into my PR to get this merged.

Please let me know @DevelopmentCats if that's okay with you. Thanks again for your help!

DevelopmentCats · 2025-07-17T02:59:37Z

Thank you so much for taking the time to test the module and provide such detailed feedback. I really appreciate you forking the repository and creating a working example it was incredibly helpful for understanding the issues with installation and proxying. Your solution is much more stable. With your permission, I would love to incorporate the changes from your cat/AJ0070-pgadmin-fix branch into my PR to get this merged.

Please let me know @DevelopmentCats if that's okay with you. Thanks again for your help!

No worries.

That's totally fine with me. I'm happy to provide in whatever way I can. Sorry I couldn't point out the exact issues right out of the gate. I had never really worked with pgadmin-web before now and it took me a minute to get it myself lol.

AJ0070 · 2025-07-17T03:03:07Z

Thanks for the confirmation!

AJ0070 · 2025-07-17T03:15:07Z

I've implemented the changes. Let me know if there's anything else you'd like adjusted.

matifali · 2025-07-17T07:26:22Z

@AJ0070, please link a video demo of the module wokring in a Coder workspace. Thanks,

AJ0070 · 2025-07-17T07:37:48Z

@AJ0070, please link a video demo of the module wokring in a Coder workspace. Thanks,

I'll do that right after I fix the workflow failure.

AJ0070 · 2025-07-19T04:59:13Z

pg-admin-test.mp4

AJ0070 · 2025-07-19T05:13:27Z

@DevelopmentCats, could you please review the recent changes when you have a moment?

bpmct · 2025-07-19T21:09:01Z

Hey @AJ0070. that video doesn't show pgadmin with coder. the agent doesn't start and there is no pgadmin button in the dashboard

AJ0070 · 2025-07-24T14:23:12Z

Now pgAdmin icon is visible:

but I am not sure why the connection is refusing:

2025-07-24 13:47:00.932 [debu]  apphealth: error checking app health  id=9830f5f2-bf28-4ef1-981a-090ccaf65dbb  slug=pgadmin  now_unhealthy=true  error="Get \"http://localhost:5050/\": dial tcp [::1]:5050: connect: connection refused"

@DevelopmentCats Did you encounter anything like this during your local testing? Let me know if you have any suggestions for resolving it.

DevelopmentCats · 2025-07-24T14:28:26Z

Now pgAdmin icon is visible:
but I am not sure why the connection is refusing:
2025-07-24 13:47:00.932 [debu]  apphealth: error checking app health  id=9830f5f2-bf28-4ef1-981a-090ccaf65dbb  slug=pgadmin  now_unhealthy=true  error="Get \"http://localhost:5050/\": dial tcp [::1]:5050: connect: connection refused"
@DevelopmentCats Did you encounter anything like this during your local testing? Let me know if you have any suggestions for resolving it.

Even in my version, it still took forever to build.

PGAdmin seems to be pretty heavy overall, and I doubt there is much to be done to speed the install up. In my testing though I was able to get pgadmin installed, and available over the coder app button.

AJ0070 · 2025-07-25T02:49:45Z

Now pgAdmin icon is visible:

but I am not sure why the connection is refusing:
2025-07-24 13:47:00.932 [debu]  apphealth: error checking app health  id=9830f5f2-bf28-4ef1-981a-090ccaf65dbb  slug=pgadmin  now_unhealthy=true  error="Get \"http://localhost:5050/\": dial tcp [::1]:5050: connect: connection refused"
@DevelopmentCats Did you encounter anything like this during your local testing? Let me know if you have any suggestions for resolving it.
Even in my version, it still took forever to build.

PGAdmin seems to be pretty heavy overall, and I doubt there is much to be done to speed the install up. In my testing though I was able to get pgadmin installed, and available over the coder app button.

Were you able to open it?

DevelopmentCats · 2025-07-25T14:46:18Z

Now pgAdmin icon is visible:

but I am not sure why the connection is refusing:
2025-07-24 13:47:00.932 [debu]  apphealth: error checking app health  id=9830f5f2-bf28-4ef1-981a-090ccaf65dbb  slug=pgadmin  now_unhealthy=true  error="Get \"http://localhost:5050/\": dial tcp [::1]:5050: connect: connection refused"
@DevelopmentCats Did you encounter anything like this during your local testing? Let me know if you have any suggestions for resolving it.
Even in my version, it still took forever to build.
PGAdmin seems to be pretty heavy overall, and I doubt there is much to be done to speed the install up. In my testing though I was able to get pgadmin installed, and available over the coder app button.
Were you able to open it?

It was not loading up when I pulled and tested it last, but let me build and test again. Maybe I can provide you some valuable output

AJ0070 · 2025-07-25T15:02:22Z

It was not loading up when I pulled and tested it last, but let me build and test again. Maybe I can provide you some valuable output

Thanks so much for looking into this. Once you share your output, I’ll be able to figure out whether the issue is with my local setup or something in the code.

AJ0070 · 2025-07-27T13:12:27Z

@DevelopmentCats, have you had a chance to test this? Your feedback would be greatly appreciated.

DevelopmentCats · 2025-07-31T16:21:16Z

@DevelopmentCats, have you had a chance to test this? Your feedback would be greatly appreciated.

Sorry about the delay on this.

I will build this in my template tonight and will provide you with the logs for the module so we can get this buttoned up

AJ0070 · 2025-08-07T00:37:04Z

@DevelopmentCats, just following up—any update?

DevelopmentCats · 2025-08-07T00:47:14Z

@DevelopmentCats, just following up—any update?

Checking now, sorry for the delay

DevelopmentCats · 2025-08-07T01:07:05Z

It seems to be loading fine for me when I just pulled it. @AJ0070

Can you upload the icon for this and pull the svg for pgadmin instead of postgres like its referencing right now. Make sure to also make a PR in coder/coder to upload the icon in site/static/icons so that it shows up properly in coder.

Also there is a typo in your avatar image please fix that.

Lastly I notice that you have changes in here for the filebrowser module. Please remove that. I will review this after you take care of those things

AJ0070 · 2025-08-07T02:40:00Z

@DevelopmentCats added logo on coder: coder/coder#19210

AJ0070 · 2025-08-07T02:49:51Z

It seems to be loading fine for me when I just pulled it. @AJ0070

Can you upload the icon for this and pull the svg for pgadmin instead of postgres like its referencing right now. Make sure to also make a PR in coder/coder to upload the icon in site/static/icons so that it shows up properly in coder.

Also there is a typo in your avatar image please fix that.

Lastly I notice that you have changes in here for the filebrowser module. Please remove that. I will review this after you take care of those things

@DevelopmentCats Ready for review

DevelopmentCats · 2025-08-07T14:39:55Z

@DevelopmentCats added logo on coder: coder/coder#19210

I would use this logo instead. but the file name and upload looks good to me.

Please make sure you sign the CLA on coder/coder#19210

AJ0070 · 2025-08-07T16:57:04Z

I would use this logo instead. but the file name and upload looks good to me.

As @aslilac mentioned here do we have proper license to redistribute it?

@DevelopmentCats

Copilot

Pull Request Overview

This PR introduces a new Coder module for pgAdmin, allowing users to easily deploy a web-based PostgreSQL database management interface in their workspaces. The module provides automated installation, configuration, and startup of pgAdmin 4 with customizable settings.

Key changes:

New pgAdmin module under the AJ0070 namespace with complete implementation
Automated pgAdmin installation and configuration through shell scripts and Terraform
Configurable deployment options including subdomain support and custom configuration

Reviewed Changes

Copilot reviewed 5 out of 7 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
registry/AJ0070/modules/pgadmin/main.tf	Terraform configuration defining Coder app and script resources with pgAdmin setup
registry/AJ0070/modules/pgadmin/run.sh	Shell script handling pgAdmin installation, virtual environment setup, and service startup
registry/AJ0070/modules/pgadmin/main.test.ts	Basic test file ensuring the module loads correctly with required variables
registry/AJ0070/modules/pgadmin/README.md	Documentation with usage instructions and module metadata
registry/AJ0070/README.md	Author profile information for the AJ0070 namespace

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-08-13T17:48:21Z

registry/AJ0070/modules/pgadmin/run.sh

+  printf "Creating Python virtual environment for pgAdmin...\n"
+  if ! python3 -m venv "$PGADMIN_VENV_DIR"; then
+    echo "⚠️  Warning: Failed to create virtual environment"
+    exit 0


The error message should be more descriptive and actionable. Consider including the specific error or suggesting potential solutions like checking Python installation or permissions.

Suggested change

exit 0

if ! python3 -m venv "$PGADMIN_VENV_DIR" 2>venv_error.log; then

echo "⚠️ Warning: Failed to create virtual environment at $PGADMIN_VENV_DIR"

echo "Error details:"

cat venv_error.log

echo "Possible causes:"

echo " - Python 3 is not installed or not found in PATH"

echo " - The 'venv' module is missing (try: python3 -m ensurepip --upgrade)"

echo " - Insufficient permissions to write to $PGADMIN_VENV_DIR"

echo " - Not enough disk space"

echo "Please check the above error and try again."

rm -f venv_error.log

exit 1

Copilot · 2025-08-13T17:48:22Z

registry/AJ0070/modules/pgadmin/run.sh

+
+  printf "Installing pgAdmin 4 in virtual environment...\n"
+  if ! "$PGADMIN_VENV_DIR/bin/pip" install pgadmin4; then
+    echo "⚠️  Warning: Failed to install pgAdmin4"


The error message should be more descriptive and actionable. Consider including information about potential causes like network issues, Python version compatibility, or suggesting to check pip installation.

Suggested change

echo "⚠️ Warning: Failed to install pgAdmin4"

echo "⚠️ Warning: Failed to install pgAdmin4. This may be due to network issues, Python version incompatibility, or a missing pip installation in the virtual environment."

echo "💡 Please check your internet connection, ensure you are using a supported Python version, and verify that pip is installed in the virtual environment ('$PGADMIN_VENV_DIR/bin/pip')."

Copilot · 2025-08-13T17:48:22Z

registry/AJ0070/modules/pgadmin/main.tf

+  description = "A map of pgAdmin configuration settings."
+  default = {
+    DEFAULT_EMAIL            = "admin@coder.com"
+    DEFAULT_PASSWORD         = "coderPASSWORD"


Using a hardcoded default password poses a security risk. Consider using a randomly generated password or requiring users to set their own password through a variable.

Copilot · 2025-08-13T17:48:22Z

registry/AJ0070/modules/pgadmin/main.tf

+    MASTER_PASSWORD_REQUIRED = false
+    LISTEN_ADDRESS           = "127.0.0.1"
+  }
+}


Using 'any' type for the config variable is too permissive and provides no type safety. Consider defining a more specific object type with optional attributes to better validate the configuration structure.

Suggested change

}

variable "config" {

type = map(any)

description = "A map of pgAdmin configuration settings."

default = {

DEFAULT_EMAIL = "admin@coder.com"

DEFAULT_PASSWORD = "coderPASSWORD"

SERVER_MODE = false

MASTER_PASSWORD_REQUIRED = false

LISTEN_ADDRESS = "127.0.0.1"

}

}

AJ0070 added 3 commits July 12, 2025 14:15

feat(pgadmin): add new module for pgAdmin

93059b8

changed display name

af16096

Removed unnecessary Document

6319e67

DevelopmentCats self-requested a review July 16, 2025 02:51

DevelopmentCats reviewed Jul 16, 2025

View reviewed changes

registry/AJ0070/modules/pgadmin/main.tf Outdated Show resolved Hide resolved

served over the subdomain by default, and then fallback to localhost

0338bd7

AJ0070 requested a review from DevelopmentCats July 16, 2025 14:29

DevelopmentCats assigned AJ0070 Jul 16, 2025

DevelopmentCats reviewed Jul 16, 2025

View reviewed changes

registry/AJ0070/modules/pgadmin/README.md Outdated Show resolved Hide resolved

AJ0070 added 3 commits July 16, 2025 14:52

improved this based on review

8f19fd9

ran fmt on the change

db8df71

added correct implementation of the review

9947034

AJ0070 force-pushed the main branch from 754fdbd to 9947034 Compare July 16, 2025 15:08

AJ0070 requested a review from DevelopmentCats July 16, 2025 15:09

incorporated the changes of forked repo

f9b3359

fix failure workflow

542f8ec

AJ0070 mentioned this pull request Jul 19, 2025

Aider Module: Tasks+AgentAPI Support #239

Open

6 tasks

Merge branch 'main' into main

c8f4ba2

AJ0070 added 2 commits August 7, 2025 02:15

fixed typo and removed changes from filebrowser

d8ed39f

fixed filebrowser run.sh

ce103bd

derefrenced postgress logo and referenced pgadmin logo

dc1872b

AJ0070 and others added 2 commits August 10, 2025 06:44

changed logo

7ea3735

Merge branch 'main' into main

5535a3e

DevelopmentCats requested a review from Copilot August 13, 2025 17:47

Copilot AI reviewed Aug 13, 2025

View reviewed changes

-    exit 0
+  if ! python3 -m venv "$PGADMIN_VENV_DIR" 2>venv_error.log; then
+    echo "⚠️  Warning: Failed to create virtual environment at $PGADMIN_VENV_DIR"
+    echo "Error details:"
+    cat venv_error.log
+    echo "Possible causes:"
+    echo "  - Python 3 is not installed or not found in PATH"
+    echo "  - The 'venv' module is missing (try: python3 -m ensurepip --upgrade)"
+    echo "  - Insufficient permissions to write to $PGADMIN_VENV_DIR"
+    echo "  - Not enough disk space"
+    echo "Please check the above error and try again."
+    rm -f venv_error.log
+    exit 1

	echo "⚠️ Warning: Failed to install pgAdmin4"
	echo "⚠️ Warning: Failed to install pgAdmin4. This may be due to network issues, Python version incompatibility, or a missing pip installation in the virtual environment."
	echo "💡 Please check your internet connection, ensure you are using a supported Python version, and verify that pip is installed in the virtual environment ('$PGADMIN_VENV_DIR/bin/pip')."

feat(pgadmin): add new module for pgAdmin #228

Are you sure you want to change the base?

feat(pgadmin): add new module for pgAdmin #228

Uh oh!

Conversation

AJ0070 commented Jul 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Module Information

Testing & Validation

Uh oh!

Uh oh!

Uh oh!

DevelopmentCats commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AJ0070 commented Jul 16, 2025

Uh oh!

AJ0070 commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DevelopmentCats commented Jul 17, 2025

Uh oh!

AJ0070 commented Jul 17, 2025

Uh oh!

AJ0070 commented Jul 17, 2025

Uh oh!

matifali commented Jul 17, 2025

Uh oh!

AJ0070 commented Jul 17, 2025

Uh oh!

AJ0070 commented Jul 19, 2025

Uh oh!

AJ0070 commented Jul 19, 2025

Uh oh!

bpmct commented Jul 19, 2025

Uh oh!

AJ0070 commented Jul 24, 2025

Uh oh!

DevelopmentCats commented Jul 24, 2025

Uh oh!

AJ0070 commented Jul 25, 2025

Uh oh!

DevelopmentCats commented Jul 25, 2025

Uh oh!

AJ0070 commented Jul 25, 2025

Uh oh!

AJ0070 commented Jul 27, 2025

Uh oh!

DevelopmentCats commented Jul 31, 2025

Uh oh!

AJ0070 commented Aug 7, 2025

Uh oh!

DevelopmentCats commented Aug 7, 2025

Uh oh!

DevelopmentCats commented Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AJ0070 commented Aug 7, 2025

Uh oh!

AJ0070 commented Aug 7, 2025

Uh oh!

DevelopmentCats commented Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AJ0070 commented Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

AJ0070 commented Jul 12, 2025 •

edited

Loading

DevelopmentCats commented Jul 16, 2025 •

edited

Loading

AJ0070 commented Jul 17, 2025 •

edited

Loading

DevelopmentCats commented Aug 7, 2025 •

edited

Loading

DevelopmentCats commented Aug 7, 2025 •

edited

Loading

AJ0070 commented Aug 7, 2025 •

edited

Loading