Installation

Installation

DBNova installs like any Laravel application. These steps take about five minutes.

#1. Get the code

git clone https://github.com/vivek-mistry/dbnova.git && cd dbnova
composer install
cp .env.example .env && php artisan key:generate

#2. Create DBNova's own database

DBNova keeps its own data (sessions, query history, the audit log, the queue) in SQLite. This is not the server you manage.

touch database/database.sqlite && php artisan migrate

#3. Build the front end

npm install && npm run build

#4. Point it at your MySQL server

Add the server address and client binaries to .env:

APP_NAME=DBNova
DBNOVA_DB_HOST=127.0.0.1
DBNOVA_DB_PORT=3306
DBNOVA_MYSQL_BIN=/usr/bin/mysql
DBNOVA_MYSQLDUMP_BIN=/usr/bin/mysqldump

Note .env only says where the server is. It never holds a MySQL username or password.

#5. Check the setup

php artisan dbnova:install

This checks the PHP extensions, the client binaries, the MySQL connection, storage and the worker, and exits with an error if anything is missing.

#6. Run it

composer run dev                                         # app + Vite during development
php artisan queue:work --queue=imports,exports,default   # imports and exports run here
php artisan schedule:work                                # recovery and cleanup

Open the app and sign in with a MySQL account. A dedicated MySQL user is recommended over root.

For a server install with nginx and supervisor, see Production setup.

0 views Something unclear? Open an issue on GitHub