📖 What is DHOOK? #

DHOOK is a lightweight webhook relay service that allows you to receive webhooks (from GitHub, Stripe, PayMe, etc.) on your local machine during development.

┌─────────────┐      ┌──────────────────┐      ┌─────────────────┐
│   GitHub    │──────▶  DHOOK Server   │──────▶  Your Laptop    │
│   Stripe    │ POST  │  (Your Server)  │  WS   │  localhost:8000 │
│   PayMe     │       └──────────────────┘      └─────────────────┘
└─────────────┘             ▲                          │
                            │                          │
                     Webhook sent here         CLI Agent receives
                                               and forwards locally

🚀 Quick Start #

Installation #

# Install globally via pub.flutter-io.cn
dart pub global activate dhook

# Or install from source
dart pub global activate --source git https://github.com/alisheraxmedov/dhook.git

1. Deploy on Your Server #

# SSH to your server
ssh user@your-server.com

# Clone repository
git clone https://github.com/alisheraxmedov/dhook.git
cd dhook

# Configure environment
cp .env.example .env
# Edit .env with your server IP

# Run with Docker
docker-compose up -d

2. CLI Agent (on your machine) #

# Set environment variables
export DHOOK_SERVER=ws://your-server.com:3000/ws/my-channel
export DHOOK_TARGET=http://localhost:8000

# Run the client
dhook client \
  --server $DHOOK_SERVER \
  --target $DHOOK_TARGET

3. Configure Your Webhook #

Point your webhook to:

http://your-server.com:3000/webhook/my-channel

🐳 Docker Deployment #

# Build and run
docker-compose up -d

# Check logs
docker-compose logs -f

# Stop
docker-compose down

🛠️ Usage #

Server Commands #

# Start relay server on default port 3000
dhook server

# Start on custom port
dhook server --port 8080

Client Commands #

# Connect to relay and forward to localhost
dhook client \
  --server ws://your-server.com:3000/ws/my-channel \
  --target http://localhost:8000

API Endpoints #

📦 Programmatic Usage #

import 'package:dhook/dhook.dart';

// Start a relay server
final server = RelayServer(port: 3000);
await server.start();

// Start a CLI agent
final agent = CliAgent(
  serverUrl: 'ws://your-server.com:3000/ws/my-channel',
  targetUrl: 'http://localhost:8000',
);
await agent.start();

⚙️ Configuration #

Copy .env.example to .env and configure:

# Server IP address or domain
DHOOK_SERVER_HOST=your-server-ip

# Server port (default: 3000)
DHOOK_SERVER_PORT=3000

🏗️ Architecture #

dhook/
├── bin/
│   └── dhook.dart          # CLI entry point
├── lib/
│   ├── dhook.dart          # Library exports
│   └── src/
│       ├── client/
│       │   └── cli_agent.dart      # WebSocket client
│       ├── server/
│       │   └── relay_server.dart   # HTTP/WebSocket server
│       ├── models/
│       │   └── webhook_payload.dart
│       └── utils/
│           └── logger.dart
├── Dockerfile
└── docker-compose.yml

📄 License #

MIT License - see LICENSE for details.

👤 Author #

Alisher Axmedov

• GitHub: @alisheraxmedov
• Email: alisheraxmedov4x4@gmail.com