Configuration

Configuration

Everything DBNova needs is set in .env. The full annotated list is in .env.example and config/dbnova.php.

#A dedicated MySQL account

Use a dedicated account for day-to-day work instead of root:

CREATE USER 'dbnova'@'localhost' IDENTIFIED BY 'a-long-random-password';
GRANT ALL PRIVILEGES ON *.* TO 'dbnova'@'localhost';    -- full manager

For a read-only viewer, grant SELECT, SHOW VIEW, PROCESS only and set DBNOVA_READ_ONLY=true.

Accounts with the global CREATE USER privilege (such as root) see every user's entries in the audit log. Other accounts see only their own.

#Settings

Setting Default What it does
DBNOVA_DB_HOST / DBNOVA_DB_PORT / DBNOVA_DB_SOCKET 127.0.0.1 / 3306 / – Where the managed MySQL server is. A socket path takes precedence over TCP.
DBNOVA_MYSQL_BIN / DBNOVA_MYSQLDUMP_BIN /usr/bin/… Full paths to the client tools. Required for imports and exports.
DBNOVA_READ_ONLY false Refuse every change to the server. Browsing, SELECT and exports still work.
DBNOVA_PAGE_SIZE / DBNOVA_MAX_PAGE_SIZE 100 / 1000 Rows per page in the table browser.
DBNOVA_QUERY_ROW_CAP / DBNOVA_MAX_QUERY_ROW_CAP 1000 / 10000 Rows the SQL editor shows. Use the CSV export for full results.
DBNOVA_QUERY_TIMEOUT_MS / DBNOVA_MAX_QUERY_TIMEOUT_MS 30000 / 300000 MySQL stops a SELECT after this long.
DBNOVA_WORK_DIR storage/app/dbnova Where uploads, export files and temp files go.
DBNOVA_MAX_UPLOAD_BYTES 100 GB Largest import file.
DBNOVA_MIN_FREE_DISK_BYTES 5 GB Free disk that imports and exports must leave.
DBNOVA_EXPORT_FILE_HOURS / DBNOVA_EXPORT_LINK_MINUTES 24 / 60 How long export files are kept, and how long a download link works.
DBNOVA_MAX_KEPT_EXPORTS 10 Finished export files one user may keep at once (0 = no limit).

#Per-user preferences

Each user can change the page size, row cap and query timeout for their own account under Settings → Preferences, up to the DBNOVA_MAX_* values above. Imports and exports always use the .env values.

#Checklist

  1. Binary paths point at real files.
  2. A dedicated MySQL account exists.
  3. A queue worker and the scheduler are running. Without them, imports and exports stay "queued".
  4. There is free disk space of about 2× your largest import.
  5. The app is served over HTTPS and, where possible, kept off the public internet.
  6. php artisan dbnova:install passes.
0 views Something unclear? Open an issue on GitHub