mirror of
https://github.com/latinogino/dolibarr-mcp.git
synced 2026-04-25 02:55:35 +02:00
Improve Docker Compose defaults and docs
This commit is contained in:
13
README.md
13
README.md
@@ -69,6 +69,10 @@ inside the virtual environment, for example
|
||||
### Docker (optional)
|
||||
|
||||
```bash
|
||||
# Copy the template and update credentials (file is gitignored)
|
||||
cp .env.example .env
|
||||
|
||||
# Start the HTTP listener for MCP clients (Open WebUI, MCPO, etc.)
|
||||
docker compose up -d
|
||||
# or
|
||||
docker build -t dolibarr-mcp .
|
||||
@@ -84,6 +88,8 @@ docker run -d \
|
||||
|
||||
The server reads configuration from the environment or a `.env` file. Both
|
||||
`DOLIBARR_URL` and `DOLIBARR_SHOP_URL` are accepted for the base API address.
|
||||
The repository `.gitignore` excludes `.env`, so a local `.env` file will not be
|
||||
overwritten by `git pull` on your server.
|
||||
|
||||
| Variable | Description |
|
||||
| --- | --- |
|
||||
@@ -93,6 +99,7 @@ The server reads configuration from the environment or a `.env` file. Both
|
||||
| `MCP_TRANSPORT` | Transport to use: `stdio` (default) or `http` for streamable HTTP. |
|
||||
| `MCP_HTTP_HOST` | Host/interface to bind when using HTTP transport (default `0.0.0.0`). |
|
||||
| `MCP_HTTP_PORT` | Port to bind when using HTTP transport (default `8080`). |
|
||||
| `MCP_HOST_PORT` | Optional host port to publish in Docker Compose (default `18004`). |
|
||||
|
||||
Example `.env`:
|
||||
|
||||
@@ -154,6 +161,12 @@ Then point Open WebUI’s MCP configuration at `http://<host>:8080/`. The MCP
|
||||
protocol headers (including `mcp-protocol-version`) are handled automatically by
|
||||
Open WebUI’s MCP client.
|
||||
|
||||
### Docker Compose listener (recommended for MCP clients)
|
||||
|
||||
The bundled `docker-compose.yml` starts the HTTP listener by default so MCP
|
||||
clients such as Open WebUI or MCPO can connect to
|
||||
`http://<host>:${MCP_HOST_PORT:-18004}/` right away.
|
||||
|
||||
### Test the Dolibarr credentials
|
||||
|
||||
Use the standalone connectivity check before wiring the server into an MCP host:
|
||||
|
||||
Reference in New Issue
Block a user