File tree Expand file tree Collapse file tree 1 file changed +44
-1
lines changed Expand file tree Collapse file tree 1 file changed +44
-1
lines changed Original file line number Diff line number Diff line change @@ -92,7 +92,50 @@ graph TD
92
92
93
93
---
94
94
95
- ## Quick Start
95
+ ## Quick Start (Pre-built Image)
96
+
97
+ If you just want to run the gateway using the official image from GitHub Container Registry:
98
+
99
+ ``` bash
100
+ docker run -d --name mcpgateway \
101
+ -p 4444:4444 \
102
+ -e HOST=0.0.0.0 \
103
+ -e JWT_SECRET_KEY=my-secret-key \
104
+ -e BASIC_AUTH_USER=admin \
105
+ -e BASIC_AUTH_PASSWORD=changeme \
106
+ -e AUTH_REQUIRED=true \
107
+ -e DATABASE_URL=sqlite:///./mcp.db \
108
+ ghcr.io/ibm/mcp-context-forge:latest
109
+
110
+ docker logs mcpgateway
111
+ ```
112
+
113
+ > 💡 You can also use ` --env-file .env ` if you have a config file already. See the provided [ .env.example] ( .env.example )
114
+
115
+ ### Optional: Mount a local volume for persistent SQLite storage
116
+
117
+ ``` bash
118
+ -v $( pwd) /data:/app
119
+ ```
120
+
121
+ ### Generate a token for API access
122
+
123
+ ``` bash
124
+ export MCPGATEWAY_BEARER_TOKEN=$( docker exec mcpgateway python3 -m mcpgateway.utils.create_jwt_token -u admin -e 10080)
125
+ ```
126
+
127
+ ### Smoke-test the running container
128
+
129
+ ``` bash
130
+ curl -s -H " Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN " \
131
+ http://localhost:4444/health
132
+ curl -s -H " Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN " \
133
+ http://localhost:4444/tools | jq
134
+ ```
135
+
136
+ ---
137
+
138
+ ## Quick Start (manual install)
96
139
97
140
### Prerequisites
98
141
You can’t perform that action at this time.
0 commit comments