xbp 0.9.2

XBP is a zero-config build pack that can also interact with proxies, kafka, sockets, synthetic monitors.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

---
title: XBP Documentation
description: Complete guide to XBP - eXtensible Build Pack for deployment, monitoring, and logging
---

# XBP Documentation

Welcome to the XBP documentation. XBP is a comprehensive deployment, monitoring, and logging toolkit with native support for Rust, Next.js, Node.js, Python, and more.

## Quick Links

- [Getting Started](/docs/getting-started)
- [Installation](/docs/installation)
- [Configuration](/docs/configuration)
- [CLI Reference](/docs/cli-reference)
- [API Reference](/docs/api-reference)

## Features

### Deployment
- Multi-service deployment support
- Rust, Next.js, Node.js, Python support
- PM2 integration
- Git-based workflows

### Monitoring
- Health check monitoring
- Response time tracking
- Status code validation
- Continuous monitoring daemon

### Logging
- Multi-file log tailing
- Kafka integration
- Real-time log streaming
- Structured log output

### System Diagnostics
- CPU, RAM, Disk monitoring
- Network statistics
- Port availability checking
- Internet speed testing
- Nginx status validation

### Nginx Integration
- Automatic reverse proxy setup
- Configuration management
- Port conflict detection
- Config validation

## Command Categories

### Core Commands
- [`xbp diag`](/docs/commands/diag) - System diagnostics
- [`xbp monitor`](/docs/commands/monitor) - Health monitoring
- [`xbp tail`](/docs/commands/tail) - Log management
- [`xbp ports`](/docs/commands/ports) - Port management

### Service Management
- [`xbp services`](/docs/commands/services) - List services
- [`xbp service`](/docs/commands/service) - Service operations
- [`xbp redeploy`](/docs/commands/redeploy) - Redeploy services

### Nginx Management
- [`xbp nginx setup`](/docs/commands/nginx-setup) - Setup reverse proxy
- [`xbp nginx list`](/docs/commands/nginx-list) - List configurations
- [`xbp nginx update`](/docs/commands/nginx-update) - Update configuration

### PM2 Management
- [`xbp list`](/docs/commands/list) - List PM2 processes
- [`xbp logs`](/docs/commands/logs) - View PM2 logs

### Utilities
- [`xbp config`](/docs/commands/config) - View configuration
- [`xbp setup`](/docs/commands/setup) - Initial setup
- [`xbp curl`](/docs/commands/curl) - HTTP requests
- [`xbp install`](/docs/commands/install) - Install packages

## Quick Start

```bash
# Install XBP
cargo install xbp

# Check system health
xbp diag

# Setup a service
xbp nginx setup --domain api.example.com --port 3000

# Monitor health
xbp monitor check

# Tail logs
xbp tail
```

## Configuration

XBP uses `xbp.json` for configuration:

```json
{
  "project_name": "my-app",
  "port": 3000,
  "services": [...],
  "monitor_url": "https://api.example.com/health",
  "log_files": ["/var/log/app/api.log"],
  "kafka_brokers": "localhost:9092"
}
```

See [Configuration Guide](/docs/configuration) for details.

## API Mode

Start XBP as an API server:

```bash
export PORT_XBP_API=8080
xbp
```

See [API Reference](/docs/api-reference) for endpoints.

## Support

- **GitHub**: [Issues](https://github.com/your-org/xbp/issues)
- **Email**: floris@xylex.ai
- **License**: MIT

## Next Steps

1. [Install XBP](/docs/installation)
2. [Configure your project](/docs/configuration)
3. [Explore commands](/docs/cli-reference)
4. [Set up monitoring](/docs/guides/monitoring)
5. [Configure logging](/docs/guides/logging)