feat: add phpMyAdmin service configuration #801

monteshot · 2024-09-16T20:55:23Z

Add docker-compose.phpmyadmin.yml for phpMyAdmin service
Update svc.cmd to conditionally include phpMyAdmin configuration
Ensure phpMyAdmin config file is generated if not present
Add regeneratePMAConfig function to core.sh
Call regeneratePMAConfig on env changes in env.cmd
Include phpMyAdmin as a global service in core.sh

- Add docker-compose.phpmyadmin.yml for phpMyAdmin service - Update svc.cmd to conditionally include phpMyAdmin configuration - Ensure phpMyAdmin config file is generated if not present - Add regeneratePMAConfig function to core.sh - Call regeneratePMAConfig on env changes in env.cmd - Include phpMyAdmin as a global service in core.sh

monteshot · 2024-09-16T20:57:45Z

bap14 · 2024-09-16T21:35:49Z

@monteshot Thanks for the contribution. I would like to suggest that you add a feature flag to this, similar to that of Portainer and DNSMasq, so that those that use external tools like DBeaver or TablePlus can opt-out of running PMA.

I should clarify. I see that you have a flag, but we're still doing unnecessary regeneration if the flag is disabled.

- Add WARDEN_PHPMYADMIN_ENABLE variable to install.cmd - Modify svc.cmd to check WARDEN_PHPMYADMIN_ENABLE - Update core.sh to regenerate phpMyAdmin config when enabled

monteshot · 2024-09-17T15:50:28Z

@bap14 Hello. Please review the updated PR.

@poespas Hi. If you use PMA by extending the warden-env.yml file in the project directory, you will have two separate PMA apps. Regarding the file in the Warden home directory, this file only needs to give information about db containers(as mentioned in PMA documentation).

…_ENABLE Add check to ensure WARDEN_HOME_DIR/.env exists and contains WARDEN_PHPMYADMIN_ENABLE. Default WARDEN_PHPMYADMIN_ENABLE to 1 if missing. Indent echo statement for consistency.

navarr · 2024-09-23T18:10:52Z

Looking over the code, I don't have any concerns. I think this is ready for testing and if all is working correctly - a merge!

Include 'sys' in the list of databases to be hidden.

monteshot · 2024-10-21T12:31:11Z

Updated the PR with the latest changes from the main branch.
Additionally, I added one more DB to the hidden database list.

@bap14 @navarr, please review and merge the PR when you are ready.
🤝

ihor-sviziev · 2024-10-03T09:53:33Z

utils/core.sh

@@ -55,3 +55,45 @@ function disconnectPeeredServices {
    (docker network disconnect "$1" ${svc} 2>&1| grep -v 'is not connected') || true
  done
 }
+function regeneratePMAConfig() {


Could you please fix formatting for this function to be the same as in others?

ihor-sviziev · 2024-10-03T10:05:12Z

utils/core.sh

+function regeneratePMAConfig() {
+
+if [[ -f "${WARDEN_HOME_DIR}/.env" ]]; then
+    # Recheck PMA since old versions of .env may not have WARDEN_PHPMYADMIN_ENABLE setting
+    eval "$(grep "^WARDEN_PHPMYADMIN_ENABLE" "${WARDEN_HOME_DIR}/.env")"
+    WARDEN_PHPMYADMIN_ENABLE="${WARDEN_PHPMYADMIN_ENABLE:-1}"
+fi
+
+if [[ "${WARDEN_PHPMYADMIN_ENABLE}" == 1 ]]; then
+    echo "Regenerating phpMyAdmin configuration..."
+    ## generate phpmyadmin connection configuration
+    pma_config_file="${WARDEN_HOME_DIR}/etc/phpmyadmin/config.user.inc.php"
+
+    cat > "${pma_config_file}" <<-EOL
+    <?php
+        \$i = 1;
+EOL
+
+    for container_id in $(docker ps -q --filter "name=mysql" --filter "name=mariadb" --filter "name=db"); do
+        container_name=$(docker inspect --format '{{.Name}}' "${container_id}" | sed 's#^/##')
+        container_ip=$(docker inspect --format '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' "${container_id}")
+        MYSQL_ROOT_PASSWORD=$(docker exec "${container_id}" printenv | grep MYSQL_ROOT_PASSWORD | awk -F '=' '{print $2}')
+        MYSQL_PASSWORD=$(docker exec "${container_id}" printenv | grep MYSQL_PASSWORD | awk -F '=' '{print $2}')
+        cat >> "${pma_config_file}" <<-EOT
+        \$cfg['Servers'][\$i]['host'] = '${container_ip}';
+        \$cfg['Servers'][\$i]['auth_type'] = 'config';
+        \$cfg['Servers'][\$i]['user'] = 'root';
+        \$cfg['Servers'][\$i]['password'] = '${MYSQL_ROOT_PASSWORD}';
+        \$cfg['Servers'][\$i]['AllowNoPassword'] = true;
+        \$cfg['Servers'][\$i]['hide_db'] = '(information_schema|performance_schema|mysql)';
+        \$cfg['Servers'][\$i]['verbose'] = '${container_name}';
+        \$i++;
+EOT
+    done
+
+    cat >> "${pma_config_file}" <<-EOT
+    ?>
+EOT
+
+echo "phpMyAdmin configuration regenerated."
+fi
+}


TBH this function look quite complicated to read.
I suggest doing following improvements:

Format the function in the same way as others

Is there any reason why we add"?>" to the end of file?

Simlify logic with multi-line sections (EOT, EOL, cat) to something like this a

{ # ... echo 'my line 1'; echo 'my line 2'; } > myfile

Suggested change

function regeneratePMAConfig() {

if [[ -f "${WARDEN_HOME_DIR}/.env" ]]; then

# Recheck PMA since old versions of .env may not have WARDEN_PHPMYADMIN_ENABLE setting

eval "$(grep "^WARDEN_PHPMYADMIN_ENABLE" "${WARDEN_HOME_DIR}/.env")"

WARDEN_PHPMYADMIN_ENABLE="${WARDEN_PHPMYADMIN_ENABLE:-1}"

fi

if [[ "${WARDEN_PHPMYADMIN_ENABLE}" == 1 ]]; then

echo "Regenerating phpMyAdmin configuration..."

## generate phpmyadmin connection configuration

pma_config_file="${WARDEN_HOME_DIR}/etc/phpmyadmin/config.user.inc.php"

cat > "${pma_config_file}" <<-EOL

<?php

\$i = 1;

EOL

for container_id in $(docker ps -q --filter "name=mysql" --filter "name=mariadb" --filter "name=db"); do

container_name=$(docker inspect --format '{{.Name}}' "${container_id}" | sed 's#^/##')

container_ip=$(docker inspect --format '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' "${container_id}")

MYSQL_ROOT_PASSWORD=$(docker exec "${container_id}" printenv | grep MYSQL_ROOT_PASSWORD | awk -F '=' '{print $2}')

MYSQL_PASSWORD=$(docker exec "${container_id}" printenv | grep MYSQL_PASSWORD | awk -F '=' '{print $2}')

cat >> "${pma_config_file}" <<-EOT

\$cfg['Servers'][\$i]['host'] = '${container_ip}';

\$cfg['Servers'][\$i]['auth_type'] = 'config';

\$cfg['Servers'][\$i]['user'] = 'root';

\$cfg['Servers'][\$i]['password'] = '${MYSQL_ROOT_PASSWORD}';

\$cfg['Servers'][\$i]['AllowNoPassword'] = true;

\$cfg['Servers'][\$i]['hide_db'] = '(information_schema|performance_schema|mysql)';

\$cfg['Servers'][\$i]['verbose'] = '${container_name}';

\$i++;

EOT

done

cat >> "${pma_config_file}" <<-EOT

?>

EOT

echo "phpMyAdmin configuration regenerated."

fi

}

function regeneratePMAConfig() {

if [[ -f "${WARDEN_HOME_DIR}/.env" ]]; then

# Recheck PMA since old versions of .env may not have WARDEN_PHPMYADMIN_ENABLE setting

eval "$(grep "^WARDEN_PHPMYADMIN_ENABLE" "${WARDEN_HOME_DIR}/.env")"

WARDEN_PHPMYADMIN_ENABLE="${WARDEN_PHPMYADMIN_ENABLE:-1}"

fi

if [[ "${WARDEN_PHPMYADMIN_ENABLE}" == 1 ]]; then

echo "Regenerating phpMyAdmin configuration..."

pma_config_file="${WARDEN_HOME_DIR}/etc/phpmyadmin/config.user.inc.php"

{

echo "<?php"

echo "\$i = 1;"

for container_id in $(docker ps -q --filter "name=mysql" --filter "name=mariadb" --filter "name=db"); do

container_name=$(docker inspect --format '{{.Name}}' "${container_id}" | sed 's#^/##')

container_ip=$(docker inspect --format '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' "${container_id}")

MYSQL_ROOT_PASSWORD=$(docker exec "${container_id}" printenv | grep MYSQL_ROOT_PASSWORD | awk -F '=' '{print $2}')

echo "\$cfg['Servers'][\$i]['host'] = '${container_ip}';"

echo "\$cfg['Servers'][\$i]['auth_type'] = 'config';"

echo "\$cfg['Servers'][\$i]['user'] = 'root';"

echo "\$cfg['Servers'][\$i]['password'] = '${MYSQL_ROOT_PASSWORD}';"

echo "\$cfg['Servers'][\$i]['AllowNoPassword'] = true;"

echo "\$cfg['Servers'][\$i]['hide_db'] = '(information_schema|performance_schema|mysql)';"

echo "\$cfg['Servers'][\$i]['verbose'] = '${container_name}';"

echo "\$i++;"

done

echo "?>"

} > "${pma_config_file}"

echo "phpMyAdmin configuration regenerated."

fi

}

ihor-sviziev · 2024-10-03T10:05:40Z

docker/docker-compose.phpmyadmin.yml

+      - traefik.http.routers.phpmyadmin.tls=true
+      - traefik.http.routers.phpmyadmin.rule=Host(`phpmyadmin.${WARDEN_SERVICE_DOMAIN:-warden.test}`)||Host(`phpmyadmin.warden.test`)
+      - traefik.http.services.phpmyadmin.loadbalancer.server.port=80
+    restart: ${WARDEN_RESTART_POLICY:-always}


Having a new line at the end of all files is a best-practice

Suggested change

restart: ${WARDEN_RESTART_POLICY:-always}

restart: ${WARDEN_RESTART_POLICY:-always}

ihor-sviziev · 2024-10-03T10:13:03Z

commands/svc.cmd

+    if [[ "${WARDEN_PHPMYADMIN_ENABLE}" == 1 ]]; then
+        if [[ ! -f "${WARDEN_HOME_DIR}/etc/phpmyadmin/config.user.inc.php" ]]; then
+            mkdir -p "${WARDEN_HOME_DIR}/etc/phpmyadmin"
+        fi
+    fi


Could you explain why it can't be in the regeneratePMAConfig function?

Can we simplify it to a single if like this?

Suggested change

if [[ "${WARDEN_PHPMYADMIN_ENABLE}" == 1 ]]; then

if [[ ! -f "${WARDEN_HOME_DIR}/etc/phpmyadmin/config.user.inc.php" ]]; then

mkdir -p "${WARDEN_HOME_DIR}/etc/phpmyadmin"

fi

fi

if [[ "${WARDEN_PHPMYADMIN_ENABLE}" == 1 && \

! -f "${WARDEN_HOME_DIR}/etc/phpmyadmin/config.user.inc.php" ]]; then

mkdir -p "${WARDEN_HOME_DIR}/etc/phpmyadmin"

fi

The main reason to leave PMA file generation here is faulting to build by docker-compose

++

commands/env.cmd

Combine the conditions for executing regeneratePMAConfig into a single if statement for improved readability.

Simplify the conditional logic for creating the phpMyAdmin configuration directory by merging nested if statements into a single condition.

Remove unnecessary function parentheses and streamline heredoc usage for phpMyAdmin configuration generation.

Streamline the generation of phpMyAdmin configuration by using a single block for echoing PHP script content, reducing redundancy and improving readability.

monteshot · 2024-10-25T07:19:35Z

@ihor-sviziev Can you review PR again?

This comment was marked as resolved.

Sign in to view

feat: add phpMyAdmin enable/disable functionality

db8f2aa

- Add WARDEN_PHPMYADMIN_ENABLE variable to install.cmd - Modify svc.cmd to check WARDEN_PHPMYADMIN_ENABLE - Update core.sh to regenerate phpMyAdmin config when enabled

fix(core.sh): ensure PMA config regeneration checks WARDEN_PHPMYADMIN…

591a2e8

…_ENABLE Add check to ensure WARDEN_HOME_DIR/.env exists and contains WARDEN_PHPMYADMIN_ENABLE. Default WARDEN_PHPMYADMIN_ENABLE to 1 if missing. Indent echo statement for consistency.

monteshot added 2 commits October 21, 2024 10:36

Merge remote-tracking branch 'origin/main' into feature-pma

8bbe1be

chore(core): update hidden databases list in configuration

85e7e0c

Include 'sys' in the list of databases to be hidden.

ihor-sviziev reviewed Oct 21, 2024

View reviewed changes

monteshot added 4 commits October 25, 2024 09:41

refactor(env.cmd): simplify condition for regenerating PMA config

44c1161

Combine the conditions for executing regeneratePMAConfig into a single if statement for improved readability.

refactor: simplify condition for phpMyAdmin directory creation

9ad14da

Simplify the conditional logic for creating the phpMyAdmin configuration directory by merging nested if statements into a single condition.

refactor(core.sh): simplify function syntax and improve readability

7aa8127

Remove unnecessary function parentheses and streamline heredoc usage for phpMyAdmin configuration generation.

refactor(core.sh): simplify phpMyAdmin config generation logic

cfcd004

Streamline the generation of phpMyAdmin configuration by using a single block for echoing PHP script content, reducing redundancy and improving readability.

ihor-sviziev approved these changes Oct 25, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add phpMyAdmin service configuration #801

feat: add phpMyAdmin service configuration #801

monteshot commented Sep 16, 2024

monteshot commented Sep 16, 2024

bap14 commented Sep 16, 2024 •

edited

Loading

This comment was marked as resolved.

monteshot commented Sep 17, 2024

navarr commented Sep 23, 2024

monteshot commented Oct 21, 2024

ihor-sviziev Oct 3, 2024

ihor-sviziev Oct 3, 2024

ihor-sviziev Oct 3, 2024

ihor-sviziev Oct 3, 2024

monteshot Oct 25, 2024

monteshot commented Oct 25, 2024

	restart: ${WARDEN_RESTART_POLICY:-always}
	restart: ${WARDEN_RESTART_POLICY:-always}

feat: add phpMyAdmin service configuration #801

Are you sure you want to change the base?

feat: add phpMyAdmin service configuration #801

Conversation

monteshot commented Sep 16, 2024

monteshot commented Sep 16, 2024

bap14 commented Sep 16, 2024 • edited Loading

This comment was marked as resolved.

monteshot commented Sep 17, 2024

navarr commented Sep 23, 2024

monteshot commented Oct 21, 2024

ihor-sviziev Oct 3, 2024

Choose a reason for hiding this comment

ihor-sviziev Oct 3, 2024

Choose a reason for hiding this comment

ihor-sviziev Oct 3, 2024

Choose a reason for hiding this comment

ihor-sviziev Oct 3, 2024

Choose a reason for hiding this comment

monteshot Oct 25, 2024

Choose a reason for hiding this comment

monteshot commented Oct 25, 2024

bap14 commented Sep 16, 2024 •

edited

Loading