update docs, improve readme

Author: sirrobot01

.github/workflows/release.yml

@@ -31,6 +31,19 @@ jobs:
           cache: npm
           cache-dependency-path: ./web/package-lock.json
 
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          registry: docker.io
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+
       - name: Login to GitHub Container Registry
         uses: docker/login-action@v3
         with:

.goreleaser.yml

@@ -66,21 +66,96 @@ release:
   footer: |
     ## Docker Images
 
-    Docker images are available on [GitHub Container Registry](https://github.com/sirrobot01/mcpulse/pkgs/container/mcpulse).
+    Docker images are available on
+
+    - [GitHub Container Registry](https://github.com/sirrobot01/mcpulse/pkgs/container/mcpulse)
+    - [Docker Hub](https://hub.docker.com/r/cy01/mcpulse)
 
     ```bash
     docker pull ghcr.io/sirrobot01/mcpulse:{{ .Tag }}
+    docker pull cy01/mcpulse:{{ .Tag }}
     ```
 
 dockers:
+  # GitHub Container Registry - amd64
   - image_templates:
       - "ghcr.io/sirrobot01/mcpulse:{{ .Tag }}"
       - "ghcr.io/sirrobot01/mcpulse:latest"
+    use: buildx
+    dockerfile: docker/Dockerfile.goreleaser
+    build_flag_templates:
+      - "--pull"
+      - "--label=org.opencontainers.image.created={{.Date}}"
+      - "--label=org.opencontainers.image.title={{.ProjectName}}"
+      - "--label=org.opencontainers.image.revision={{.FullCommit}}"
+      - "--label=org.opencontainers.image.version={{.Version}}"
+      - "--platform=linux/amd64"
+    goarch: amd64
+
+  # GitHub Container Registry - arm64
+  - image_templates:
+      - "ghcr.io/sirrobot01/mcpulse:{{ .Tag }}-arm64"
+      - "ghcr.io/sirrobot01/mcpulse:latest-arm64"
+    use: buildx
+    dockerfile: docker/Dockerfile.goreleaser
+    build_flag_templates:
+      - "--pull"
+      - "--label=org.opencontainers.image.created={{.Date}}"
+      - "--label=org.opencontainers.image.title={{.ProjectName}}"
+      - "--label=org.opencontainers.image.revision={{.FullCommit}}"
+      - "--label=org.opencontainers.image.version={{.Version}}"
+      - "--platform=linux/arm64"
+    goarch: arm64
+
+  # Docker Hub - amd64
+  - image_templates:
+      - "docker.io/cy01/mcpulse:{{ .Tag }}"
+      - "docker.io/cy01/mcpulse:latest"
+    use: buildx
+    dockerfile: docker/Dockerfile.goreleaser
+    build_flag_templates:
+      - "--pull"
+      - "--label=org.opencontainers.image.created={{.Date}}"
+      - "--label=org.opencontainers.image.title={{.ProjectName}}"
+      - "--label=org.opencontainers.image.revision={{.FullCommit}}"
+      - "--label=org.opencontainers.image.version={{.Version}}"
+      - "--platform=linux/amd64"
+    goarch: amd64
+
+  # Docker Hub - arm64
+  - image_templates:
+      - "docker.io/cy01/mcpulse:{{ .Tag }}-arm64"
+      - "docker.io/cy01/mcpulse:latest-arm64"
+    use: buildx
     dockerfile: docker/Dockerfile.goreleaser
     build_flag_templates:
       - "--pull"
       - "--label=org.opencontainers.image.created={{.Date}}"
       - "--label=org.opencontainers.image.title={{.ProjectName}}"
       - "--label=org.opencontainers.image.revision={{.FullCommit}}"
       - "--label=org.opencontainers.image.version={{.Version}}"
-      - "--platform=linux/amd64"
+      - "--platform=linux/arm64"
+    goarch: arm64
+
+docker_manifests:
+  # GHCR manifests
+  - name_template: "ghcr.io/sirrobot01/mcpulse:{{ .Version }}"
+    image_templates:
+      - "ghcr.io/sirrobot01/mcpulse:{{ .Version }}-amd64"
+      - "ghcr.io/sirrobot01/mcpulse:{{ .Version }}-arm64"
+
+  - name_template: "ghcr.io/sirrobot01/mcpulse:latest"
+    image_templates:
+      - "ghcr.io/sirrobot01/mcpulse:latest-amd64"
+      - "ghcr.io/sirrobot01/mcpulse:latest-arm64"
+
+  # Docker Hub manifests
+  - name_template: "docker.io/cy01/mcpulse:{{ .Version }}"
+    image_templates:
+      - "docker.io/cy01/mcpulse:{{ .Version }}-amd64"
+      - "docker.io/cy01/mcpulse:{{ .Version }}-arm64"
+
+  - name_template: "docker.io/cy01/mcpulse:latest"
+    image_templates:
+      - "docker.io/cy01/mcpulse:latest-amd64"
+      - "docker.io/cy01/mcpulse:latest-arm64"

README.md

@@ -45,51 +45,37 @@
 
 ## Quick Start
 
-### Prerequisites
+### Using Docker (Recommended)
 
-- Docker & Docker Compose
-- OR: Go 1.21+ and Node.js 20+ (for local development)
-
-### Using Docker Compose (Recommended)
-
-1. Clone the repository:
-```bash
-git clone https://github.com/sirrobot01/mcpulse.git
-cd mcpulse
-```
-
-2. Create environment file:
 ```bash
-cp .env.example .env
-cp config.yaml.example config.yaml
-# Edit .env and config.yaml to set database credentials and desired ports.
-```
+# Download configuration files
+curl -O https://raw.githubusercontent.com/sirrobot01/mcpulse/main/docker-compose.yml
+curl -o config.yaml https://raw.githubusercontent.com/sirrobot01/mcpulse/main/config.yaml.example
 
-3. Start the services:
-```bash
+# Start MCPulse
 docker compose up -d
 ```
 
-4. Access the dashboard:
-```
-http://localhost:8080         # Main application
-http://localhost:8080/metrics # Prometheus metrics
-http://localhost:8080/health  # Health check
-```
+Access the dashboard at **http://localhost:8080**
+
+### Docker Images
+
+Pre-built images are available:
+- **GitHub Container Registry**: `ghcr.io/sirrobot01/mcpulse:latest`
+- **Docker Hub**: `cy01//mcpulse:latest`
+
+For detailed installation and configuration, see the [documentation](https://docs.mcpulse.io)
 
-This starts:
-- **MCPulse Server**: http://localhost:8080
-- **gRPC Server**: localhost:9090(this is used for thr SDKs)
-- **Prometheus Metrics**: http://localhost:8080/metrics
 
 ## SDKs
 
-MCPulse provides official SDKs for easy integration with your MCP servers:
+### Integration SDKs
+- **Python**: https://github.com/sirrobot01/mcpulse-python
+- **Go**: https://github.com/sirrobot01/mcpulse-go
+- **Node.js/TypeScript**: coming soon
 
-- Python: https://github.com/sirrobot01/mcpulse-python
-- Go: https://github.com/sirrobot01/mcpulse-go
-- Node.js/TypeScript: coming soon
-- MCPulse Proxy: coming soon
+### MCP Server
+- **mcp-mcpulse**: https://github.com/sirrobot01/mcp-mcpulse - Query MCPulse data from any MCP client
 
 
 ## Documentation

config.yaml.example

@@ -2,9 +2,6 @@ server:
   host: "0.0.0.0"
   port: 8080
   grpc_port: 9090
-  read_timeout: "30s"
-  write_timeout: "30s"
-  idle_timeout: "120s"
 
 database:
   type: "timescaledb"
@@ -13,30 +10,7 @@ database:
   database: "mcp_analytics"
   username: "mcp_user"
   password: "changeme"
-  max_connections: 50
-  max_idle_connections: 10
-  connection_max_lifetime: "1h"
   migrations_path: "migrations"
-  retention:
-    raw_data: "90d"
-    hourly_aggregates: "1y"
-    daily_aggregates: "forever"
-
-ingestion:
-  buffer_size: 10000
-  batch_size: 1000
-  batch_timeout: "5s"
-  max_batch_wait: "10s"
-  rate_limit:
-    enabled: true
-    requests_per_second: 1000
-    burst: 2000
-
-auth:
-  api_keys:
-    - key: "sk_dev_replace_this_key"
-      name: "Development"
-      permissions: ["read", "write"]
 
 privacy:
   sanitize_parameters: true
@@ -59,9 +33,3 @@ logging:
   level: "info"
   format: "json"
   output: "stdout"
-
-features:
-  websocket: true
-  anomaly_detection: false
-  alerting: false
-  multi_tenancy: false

docker-compose.yml

@@ -21,9 +21,7 @@ services:
 
   # MCPulse Server
   mcpulse:
-    build:
-      context: .
-      dockerfile: docker/Dockerfile
+    image: ghcr.io/sirrobot01/mcpulse:latest
     container_name: mcpulse-server
     environment:
       MCPULSE_DATABASE_HOST: timescale

docs/docs/configuration.md

@@ -56,10 +56,6 @@ auth:
   jwt_secret: "your-secret-key-here-at-least-32-chars"
   access_token_ttl: "15m"
   refresh_token_ttl: "7d"
-  api_keys:
-    - key: "sk_dev_replace_this_key"
-      name: "Development"
-      permissions: ["read", "write"]
 
 privacy:
   sanitize_parameters: true
@@ -84,12 +80,6 @@ logging:
   level: "info"
   format: "json"
   output: "stdout"
-
-features:
-  websocket: true
-  anomaly_detection: false
-  alerting: false
-  multi_tenancy: false
 ```
 
 ## Server Configuration
@@ -248,28 +238,6 @@ auth:
 
   # Refresh token lifetime
   refresh_token_ttl: "7d"
-
-  # Static API keys (for SDK authentication)
-  api_keys:
-    - key: "sk_prod_abc123..."
-      name: "Production"
-      permissions: ["read", "write"]
-    - key: "sk_dev_xyz789..."
-      name: "Development"
-      permissions: ["read", "write"]
-```
-
-### Generating API Keys
-
-Use the CLI to generate secure API keys:
-
-```bash
-mcpulse auth create-key --name "Production Server"
-```
-
-Or generate manually:
-```bash
-openssl rand -hex 32
 ```
 
 ### Environment Variables
@@ -465,41 +433,6 @@ This will check for:
 - Type correctness
 - Security issues (weak secrets, etc.)
 
-## Production Best Practices
-
-### Security
-
-1. **Use strong JWT secrets**:
-   ```bash
-   openssl rand -base64 48
-   ```
-
-2. **Enable parameter sanitization**:
-   ```yaml
-   privacy:
-     sanitize_parameters: true
-   ```
-
-3. **Use environment variables for secrets**:
-   ```bash
-   export MCPULSE_DATABASE_PASSWORD="..."
-   export MCPULSE_AUTH_JWT_SECRET="..."
-   ```
-
-### Performance
-
-1. **Tune buffer sizes** for your load
-2. **Adjust batch timeout** based on latency requirements
-3. **Configure retention** to manage storage
-4. **Set appropriate connection pool sizes**
-
-### Reliability
-
-1. **Enable health checks** for monitoring
-2. **Configure appropriate timeouts**
-3. **Enable Prometheus metrics**
-4. **Use JSON logging** for structured logs
-
 ## Example Configurations
 
 ### Development
@@ -517,45 +450,6 @@ privacy:
   sanitize_parameters: false
 ```
 
-### Production
-
-```yaml
-server:
-  host: "0.0.0.0"
-  port: 8080
-database:
-  host: "db.prod.example.com"
-  max_connections: 100
-  retention:
-    raw_data: "30d"
-    hourly_aggregates: "1y"
-logging:
-  level: "info"
-  format: "json"
-privacy:
-  sanitize_parameters: true
-monitoring:
-  prometheus:
-    enabled: true
-```
-
-### High Availability
-
-```yaml
-server:
-  port: 8080
-  read_timeout: "60s"
-  write_timeout: "60s"
-database:
-  max_connections: 200
-  max_idle_connections: 50
-ingestion:
-  buffer_size: 50000
-  batch_size: 5000
-  rate_limit:
-    requests_per_second: 10000
-```
-
 ## Next Steps
 
 - [Integrate an SDK](./sdks/overview)