You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+48-9Lines changed: 48 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,26 @@
2
2
3
3
StarQuery is a desktop and web database/resource browser with support for SQL datasources, Elasticsearch, and S3-compatible object storage.
4
4
5
+
## Docker Quick Start
6
+
7
+
Run the prebuilt single-image deployment:
8
+
9
+
```bash
10
+
docker run -it --rm \
11
+
-p 8080:8080 \
12
+
--add-host=host.docker.internal:host-gateway \
13
+
-v starquery-data:/var/lib/starquery \
14
+
interaapps/starquery
15
+
```
16
+
17
+
Then open:
18
+
19
+
- App: `http://localhost:8080`
20
+
21
+
Networking note:
22
+
- If StarQuery inside the container should connect to services running on your host machine, use `host.docker.internal` as the host in your datasource config instead of `localhost`.
23
+
- The `--add-host=host.docker.internal:host-gateway` flag makes that work on Linux as well.
24
+
5
25
Status:
6
26
- Work in progress
7
27
- No stable releases yet
@@ -39,7 +59,8 @@ Runtime targets:
39
59
40
60
- Intended for self-hosting on a server
41
61
- Auth is enabled by default
42
-
- Uses MySQL as the default meta database
62
+
- Uses MySQL as the default meta database in the generic backend config
63
+
- The published Docker image uses SQLite for the meta database by default so no extra DB is required
43
64
- Can optionally bootstrap users, projects, and datasources from JSON
44
65
45
66
### Plain web frontend
@@ -73,9 +94,10 @@ Use `docker compose down -v` if you want to wipe the database and re-run the see
73
94
## Hosted Docker Deployment
74
95
75
96
There is a dedicated Docker deployment for the hosted web version with:
76
-
- a Vite-built frontend served by Nginx
77
-
- a Node backend
78
-
- a MySQL metastore for users, roles, projects, datasources, tokens, and settings
97
+
- one Node app image that serves both the built frontend and the backend API
98
+
- a SQLite metastore by default, stored in a Docker volume
99
+
100
+
This means the default self-hosted setup does not require any separate database container or database configuration.
If you prefer MySQL for the metastore, you can still switch the backend to MySQL by providing the normal `STARQUERY_META_MYSQL_*` environment variables in your own compose override.
145
+
107
146
## Configuration Overview
108
147
109
148
There are three main configuration surfaces:
@@ -145,7 +184,7 @@ These are read by the StarQuery backend.
145
184
146
185
| Variable | Default | Description |
147
186
| --- | --- | --- |
148
-
|`STARQUERY_META_DRIVER`|`mysql` in hosted mode, `sqlite` in local mode | Meta database driver. Valid values: `mysql`, `sqlite`. |
187
+
|`STARQUERY_META_DRIVER`|`mysql` in hosted mode, `sqlite` in local mode | Meta database driver. Valid values: `mysql`, `sqlite`. The bundled Docker hosted deployment overrides this to `sqlite` by default so no extra DB is required. |
149
188
|`STARQUERY_META_SQLITE_PATH`|`<cwd>/.starquery/starquery-meta.sqlite`| SQLite file path for the meta database. Only used when `STARQUERY_META_DRIVER=sqlite`. |
150
189
|`STARQUERY_META_MYSQL_HOST`|`127.0.0.1`| MySQL host for the meta database. |
151
190
|`STARQUERY_META_MYSQL_PORT`|`3307`| MySQL port for the meta database. |
0 commit comments