https://github.com/joelseq/sqliteadmin-go
Admin tool for interacting with an embedded SQLite database
https://github.com/joelseq/sqliteadmin-go
admin admin-dashboard golang golang-library sqlite sqlite3
Last synced: 4 months ago
JSON representation
Admin tool for interacting with an embedded SQLite database
- Host: GitHub
- URL: https://github.com/joelseq/sqliteadmin-go
- Owner: joelseq
- License: mit
- Created: 2025-02-18T02:30:10.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-02-21T01:49:55.000Z (11 months ago)
- Last Synced: 2025-08-31T10:58:26.145Z (4 months ago)
- Topics: admin, admin-dashboard, golang, golang-library, sqlite, sqlite3
- Language: Go
- Homepage: https://sqliteadmin.dev
- Size: 2.23 MB
- Stars: 39
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SQLite Admin
[](https://github.com/joelseq/sqliteadmin-go/actions/workflows/build.yml)
SQLite Admin is a Golang library and binary which enables you to easily interact with a SQLite database. It allows you to:
- Browse tables and their schemas.
- View table data along with adding filters, limits and offsets.
- Modify individual columns in existing rows.
It can either be integrated into an existing Golang backend as a library or installed as a binary.
The web server can be interacted with by going to https://sqliteadmin.dev.
The source code for the web UI can be found at https://github.com/joelseq/sqliteadmin-ui
## Motivation
SQLite is very easy to add as an embedded database but it's difficult to manage the database once it's deployed in an application.
Existing tools primarily focus on local SQLite files, requiring manual interaction through CLI tools or desktop applications. If your SQLite database is running embedded within an application, there are few (if any) solutions that let you inspect, query, and modify it without complex workarounds.
The alternative is to use a cloud-hosted version like those provided by [Turso](https://turso.tech/) which enables interacting with the database using tools like [Drizzle Studio](https://orm.drizzle.team/drizzle-studio/overview). This adds complexity to the setup and deployment of your application and you lose out on the value of having an embedded database.
This project fills that gap by providing an easy way to view and manage an embedded SQLite database via a web UI — no need to migrate to a cloud provider or use ad-hoc solutions.
## Using as a library
```go
config := sqliteadmin.Config{
DB: db, // *sql.DB
Username: "username", // username to use to login from https://sqliteadmin.dev
Password: "password", // password to use to login from https://sqliteadmin.dev
Logger: logger, // optional, implements the Logger interface
}
admin := sqliteadmin.New(config)
// HandlePost is a HandlerFunc that you can pass in to your router
router.Post("/admin", admin.HandlePost)
```
Check out the full code at `examples/chi/main.go`.
You can also run the example to test out the admin UI:
```bash
go run examples/chi/main.go
```
This will spin up a server on `http://localhost:8080`. You can then interact with your local server by going to `https://sqliteadmin.dev` and passing in the following credentials:
```
username: user
password: password
endpoint: http://localhost:8080/admin
```
> [!NOTE]
> If you are seeing "An unexpected error occurred" when trying to connect, try disabling your adblock.
## Installing as a binary
1. Using `go install`:
```bash
go install github.com/joelseq/sqliteadmin-go/cmd/sqliteadmin@latest
```
2. Using `go build` (after cloning the repository):
```bash
make build
```
This will add the `sqliteadmin` binary to `/tmp/bin`
### Usage
In order to add authentication, the following environment variables are required: `SQLITEADMIN_USERNAME`, `SQLITEADMIN_PASSWORD`.
e.g.:
```bash
export SQLITEADMIN_USERNAME=user
export SQLITEADMIN_PASSWORD=password
```
Start the server
```bash
sqliteadmin serve -p 8080
```
Your SQLite database can now be accessed by visiting https://sqliteadmin.dev and providing the credentials and endpoint (including port).
## Inspiration
The UI is heavily inspired by [Drizzle Studio](https://orm.drizzle.team/drizzle-studio/overview).