jonesckevin/sql-navigator repository overview

⁠SQL Navigator

docker build -t sql-navigator .
docker run -d -p 9000:8080 --name sql-navigator sql-navigator

This project is meant to be simple, lightweight, and easy to deploy using docker. Designed to navigate and query databases inclduing MySQL, PostgreSQL, Redis, Cassandra, and SQLite. It is not meant to be a full-featured database management tool, but rather a simple and fast way to run queries and view results.

It comes with a single admin account for authentication, and all database connections are stored in a JSON file on the server.

⁠Setup Guide Docker

⁠Docker Compose

docker compose up --build

⁠Docker Run

docker build -t sql-navigator .
docker run -d -p 9000:8080 --name sql-navigator sql-navigator

⁠Docker Hub

docker pull jonesckevin/sql-navigator:latest
docker run -d -p 9000:8080 --name sql-navigator -v "./data/exports:/app/exports" jonesckevin/sql-navigator:latest

⁠Recover your database connection passwords

A script is provided to decrypt the passwords in the connections file, creating a new file with plaintext passwords for easier management and backup. To decrypt, you will need to input your (ideally safe and backed up) secret key from the .env file.

python scripts/decrypt_connections.py exports/connections.json

⁠License

This project is licensed under the MIT License — see the LICENSE⁠ file for details.

⁠Quick Summary

You are free to:

• ✅ Use for commercial and private purposes
• ✅ Modify the code
• ✅ Distribute the software
• ✅ Use the software privately

Under the condition that:

• 📋 Include a copy of the license and copyright notice