DDEV Dbgate

Overview

This add-on integrates Dbgate into your DDEV project.

Installation

ddev add-on get stefpe/ddev-dbgate
ddev restart

After installation, make sure to commit the .ddev directory to version control.

Usage

Command	Description
`ddev dbgate`	Launch Dbgate in the browser
`ddev describe`	View service status and used ports for Dbgate
`ddev logs -s dbgate`	Check Dbgate logs

After starting, Dbgate will be available at:

http://dbgate.project.ddev.site:8048
https://dbgate.project.ddev.site:8049

Advanced Customization

Connections

You can manage your database connections in .ddev/.env.dbgate. By default, it includes MySQL, Postgres, and Redis with DDEV defaults.

To add or modify connections, edit the CONNECTIONS list and add the corresponding LABEL_, SERVER_, USER_, PASSWORD_, PORT_, and ENGINE_ variables.

Example for a custom connection:

CONNECTIONS=mysql,my_custom_db

# ... existing mysql config ...

LABEL_my_custom_db=Custom DB
SERVER_my_custom_db=custom-service
USER_my_custom_db=user
PASSWORD_my_custom_db=pass
PORT_my_custom_db=5432
ENGINE_my_custom_db=postgres@dbgate-plugin-postgres

Docker Image

To change the Docker image:

ddev dotenv set .ddev/.env.dbgate --dbgate-docker-image="dbgate/dbgate:latest"
ddev add-on get stefpe/ddev-dbgate
ddev restart

Make sure to commit the .ddev/.env.dbgate file to version control.

All customization options (use with caution):

Variable	Flag	Default
`DBGATE_DOCKER_IMAGE`	`--dbgate-docker-image`	`dbgate/dbgate:latest`

Credits

Contributed and maintained by @stefpe