docs(onboarding): improve new user experience + fix OpenPanel tools
- Add DOCKER_README.md for Docker Hub overview page
- Fix docker-compose.yaml port mapping for local users ("8000:8000")
- Add "Verify It Works" section with dashboard URL to README
- Restructure env.example with clear REQUIRED section
- Add post-Docker verification checklist to getting-started.md
- Fix 4 OpenPanel tools: parameter ordering (non-default before default)
- Rebrand all "Coolify Projects" to "MCP Hub" in server and Dockerfile
- Make MCP namespace prefix stripping generic
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
20
README.md
20
README.md
@@ -72,14 +72,15 @@ MCP Hub is the first MCP server that lets you manage WordPress, WooCommerce, and
|
||||
git clone https://github.com/airano-ir/mcphub.git
|
||||
cd mcphub
|
||||
cp env.example .env
|
||||
# Edit .env with your site credentials
|
||||
# Edit .env — set MASTER_API_KEY and add your site credentials
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
### Option 2: PyPI
|
||||
### Option 2: Docker Hub (No Clone)
|
||||
|
||||
```bash
|
||||
pip install mcphub-server
|
||||
# Create a .env file with your credentials (see "Configure Your Sites" below)
|
||||
docker run -d --name mcphub -p 8000:8000 --env-file .env airano/mcphub:latest
|
||||
```
|
||||
|
||||
### Option 3: From Source
|
||||
@@ -93,6 +94,19 @@ cp env.example .env
|
||||
python server.py --transport sse --port 8000
|
||||
```
|
||||
|
||||
### Verify It Works
|
||||
|
||||
After starting the server, wait ~30 seconds then:
|
||||
|
||||
```bash
|
||||
# Check server health
|
||||
curl http://localhost:8000/health
|
||||
```
|
||||
|
||||
Open the **web dashboard** in your browser: **http://localhost:8000/dashboard**
|
||||
|
||||
You should see the login page. Use your `MASTER_API_KEY` to log in.
|
||||
|
||||
### Configure Your Sites
|
||||
|
||||
Add site credentials to `.env`:
|
||||
|
||||
Reference in New Issue
Block a user