DDEV LibreDB Studio

Overview

LibreDB Studio is an open-source, web-based SQL IDE with AI query assistance.

This add-on integrates LibreDB Studio into your DDEV project. Studio opens already connected to the project database, whether it is MySQL, MariaDB or PostgreSQL. MongoDB, Redis and SQL Server from the DDEV add-ons can be connected as well, one setting each.

Installation

ddev add-on get libredb/ddev-libredb-studio
ddev restart

After installation, make sure to commit the .ddev directory to version control. The login secrets are not part of it: they live in .ddev/.env.libredb-studio.local, which Git must ignore (see Login).

DDEV v1.25.4 or later is required.

Usage

Login

Studio has no passwordless mode, so the add-on generates a login for each developer:

• The admin email is [email protected].
• The admin password and the session signing key (JWT_SECRET) are random, created on install or on the first ddev start without them, and kept from then on.
• Both are stored in .ddev/.env.libredb-studio.local, which only you can read and Git ignores, so a teammate who clones the project gets their own on their first ddev start.
• ddev libredb-studio prints the login before it opens the browser.

LibreDB Studio 0.18.0 and later keep their accounts in the add-on’s data volume, ddev-<project>_libredb-studio, and take the admin password from the secrets file only on their first start. A password created later, after the secrets file was deleted or the add-on was removed and added again, does not sign in while that volume holds the earlier account. To start over with new values, run ddev stop, delete .ddev/.env.libredb-studio.local and the volume with docker volume rm ddev-<project>_libredb-studio, then run ddev start. This also removes Studio’s saved queries and settings.

DDEV keeps .ddev/.env.*.local files out of Git through .ddev/.gitignore, but only while DDEV manages that file. Before it writes the secrets, and on every start, the add-on asks Git whether the file is ignored, and stops with an error if it is not. If you manage .ddev/.gitignore yourself (it has no #ddev-generated line), add this line to it:

/.env.*.local

The secrets also leave that file in two places on your machine. DDEV writes the resolved values into .ddev/.ddev-docker-compose-full.yaml, which Git ignores and which the add-on makes readable by you only after every start. They are also part of the container’s environment, so docker inspect shows them to anyone who can use Docker on this machine. This is the same exposure as any other value DDEV passes to a container, and the login guards a local development tool, not a shared server.

Connections

Every connection is managed: its password stays on the server, and the connection cannot be edited in the browser. Every connection is visible to the admin account only, because each one logs in with a superuser account.

Each connection reaches the service by the container name DDEV gives it in this project, such as ddev-<project>-db, and never by the short service name. All DDEV projects share one Docker network, on which a short name like db also answers for another running project’s container.

For example, to add Redis:

ddev add-on get ddev/ddev-redis
ddev dotenv set .ddev/.env.libredb-studio --libredb-studio-seed-redis=true
ddev restart

When a connection is switched on and its service is missing, the LibreDB Studio container stops with an error naming the add-on to install, and ddev restart fails. A project without a db container starts LibreDB Studio without a db connection, after a 30-second wait for the service; set LIBREDB_STUDIO_SEED_DB=false to skip that wait.

Plain http

When your project is served over plain http (mkcert is not installed), the browser drops Studio’s login cookie, and ddev libredb-studio stops with a message. Either install mkcert with mkcert -install and run ddev restart, or allow the cookie over http:

ddev dotenv set .ddev/.env.libredb-studio --auth-cookie-secure=false
ddev restart

Advanced Customization

To run a different LibreDB Studio release than the one this add-on version pins:

ddev dotenv set .ddev/.env.libredb-studio --libredb-studio-docker-image="ghcr.io/libredb/libredb-studio:<version>"
ddev restart

The add-on is tested with the pinned release only.

Make sure to commit the .ddev/.env.libredb-studio file to version control. Do not put a password in it: use .ddev/.env.libredb-studio.local for that.

All customization options (use with caution):

Other LibreDB Studio settings, such as an AI provider, can be set in .ddev/.env.libredb-studio the same way; see .env.example. Keep their keys and tokens in .ddev/.env.libredb-studio.local.

Removal

ddev add-on remove libredb-studio
ddev restart

Removal deletes .ddev/.env.libredb-studio.local. Saved queries and settings stay in the Docker volume ddev-<project>_libredb-studio until you remove it with docker volume rm. The volume also keeps Studio’s admin account, so after the add-on is added again its new password signs in only once that volume is removed (see Login).

Credits

Contributed and maintained by LibreDB