Skip to content

Commit a137f04

Browse files
committed
chore: add Docker command
1 parent ed31421 commit a137f04

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
</a>
77
</p>
88

9-
DBHub is a universal database gateway implementing the Model Context Protocol (MCP) server interface. This gateway allows MCP-compatible client to connect to and explore different databases.
9+
DBHub is a universal database gateway implementing the Model Context Protocol (MCP) server interface. This gateway allows MCP-compatible clients to connect to and explore different databases.
1010

1111
```bash
1212
+------------------+ +--------------+ +------------------+
@@ -35,6 +35,18 @@ DBHub is a universal database gateway implementing the Model Context Protocol (M
3535

3636
## Usage
3737

38+
### Docker
39+
40+
```bash
41+
docker run --rm --init \
42+
--name dbhub \
43+
--publish 8080:8080 \
44+
bytebase/dbhub \
45+
--transport sse \
46+
--port 8080 \
47+
--dsn "postgres://user:password@localhost:5432/dbname?sslmode=disable"
48+
```
49+
3850
### Configure your database connection
3951

4052
DBHub requires a Database Source Name (DSN) to connect to your database. You can provide this in several ways:
@@ -89,15 +101,17 @@ Add to `claude_desktop_config.json`
89101
```json
90102
{
91103
"mcpServers": {
92-
"postgres": {
104+
"dbhub": {
93105
"command": "docker",
94106
"args": [
95107
"run",
96108
"-i",
97109
"--rm",
98110
"bytebase/dbhub",
111+
"--transport",
112+
"stdio",
99113
"--dsn",
100-
"postgresql://host.docker.internal:postgres:5432/bytebase"
114+
"postgres://user:password@host.docker.internal:5432/dbname?sslmode=disable"
101115
]
102116
}
103117
}

0 commit comments

Comments
 (0)