Azreyo/Carbon
1
1
Fork 0
Code Actions Packages Projects Releases Wiki Activity

Update documentation to reflect current implementation and add Docker support details

Browse Source
This commit is contained in:
Azreyo
2025-11-25 17:45:36 +01:00
parent 200cc8ad7f
commit 2173258a21
2 changed files with 300 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

279
DOCUMENTATION.md
View File

@@ -1,7 +1,7 @@
# Carbon HTTP Server - Complete Documentation # Carbon HTTP Server - Complete Documentation
> ⚠️ Warning some features are not implemented yet in the documentation and can be broken. Work in progress
> ⚒️ Features that are WIP will be marked. > **Note**: This documentation reflects the current implementation. Carbon is actively developed and continuously improved.
## Table of Contents ## Table of Contents
1. [Introduction](#introduction) 1. [Introduction](#introduction)
@@ -26,10 +26,12 @@ Carbon is a high-performance HTTP/HTTPS server written in C for Linux systems. I
- **HTTP/2 Protocol**: Full implementation with ALPN negotiation, multiplexing, and HPACK compression - **HTTP/2 Protocol**: Full implementation with ALPN negotiation, multiplexing, and HPACK compression
- **WebSocket Support**: RFC 6455 compliant with secure WebSocket (wss://) support - **WebSocket Support**: RFC 6455 compliant with secure WebSocket (wss://) support
- **SSL/TLS Encryption**: OpenSSL integration with modern cipher suites - **SSL/TLS Encryption**: OpenSSL integration with modern cipher suites and ALPN
- **Asynchronous I/O**: Epoll-based event handling for high concurrency - **Asynchronous I/O**: Epoll-based event handling for high concurrency
- **Thread Pooling**: Efficient multi-threaded request handling - **Thread Pooling**: Efficient multi-threaded request handling with task queue
- **Security**: Rate limiting, security headers, input sanitization, memory safety - **Performance Optimizations**: mmap caching, buffer pooling, zero-copy transfers, gzip compression
- **Security**: Dynamic rate limiting, security headers, input sanitization, memory safety
- **Docker Support**: Full containerization with Docker and Docker Compose
### System Requirements ### System Requirements
@@ -39,7 +41,9 @@ Carbon is a high-performance HTTP/HTTPS server written in C for Linux systems. I
- OpenSSL 1.1.0+ (libssl-dev) - OpenSSL 1.1.0+ (libssl-dev)
- libmagic (libmagic-dev) - libmagic (libmagic-dev)
- nghttp2 1.0.0+ (libnghttp2-dev) - nghttp2 1.0.0+ (libnghttp2-dev)
- zlib (zlib1g-dev)
- pthread (usually included) - pthread (usually included)
- pkg-config
--- ---
@@ -62,11 +66,17 @@ Carbon is a high-performance HTTP/HTTPS server written in C for Linux systems. I
│ ├─── WebSocket Handler │ │ ├─── WebSocket Handler │
│ └─── SSL/TLS Handler (OpenSSL) │ │ └─── SSL/TLS Handler (OpenSSL) │
├─────────────────────────────────────────────────────────────┤ ├─────────────────────────────────────────────────────────────┤
│ Performance Layer │
│ ├─── Task Queue (Lock-free) │
│ ├─── Buffer Pool │
│ ├─── Memory-Mapped File Cache │
│ └─── CPU Affinity Manager │
├─────────────────────────────────────────────────────────────┤
│ Core Services │ │ Core Services │
│ ├─── Configuration Manager │ │ ├─── Configuration Manager │
│ ├─── Logging System │ │ ├─── Logging System │
│ ├─── Rate Limiter │ │ ├─── Dynamic Rate Limiter │
│ ├─── File Cache │ │ ├─── Gzip Compression │
│ └─── MIME Type Detection │ │ └─── MIME Type Detection │
└─────────────────────────────────────────────────────────────┘ └─────────────────────────────────────────────────────────────┘
``` ```
@@ -92,11 +102,18 @@ Carbon/
│ ├── http2.c # HTTP/2 implementation │ ├── http2.c # HTTP/2 implementation
│ ├── http2.h # HTTP/2 headers │ ├── http2.h # HTTP/2 headers
│ ├── websocket.c # WebSocket implementation │ ├── websocket.c # WebSocket implementation
│ └── websocket.h # WebSocket headers │ ├── websocket.h # WebSocket headers
│ ├── performance.c # Performance optimizations
│ ├── performance.h # Performance headers
│ └── bin/ # Compiled object files
├── www/ # Web root directory ├── www/ # Web root directory
├── certs/ # SSL certificates ├── ssl/ # SSL certificates
│ ├── cert/ # Certificate directory
│ └── key/ # Private key directory
├── log/ # Log files ├── log/ # Log files
├── Makefile # Build configuration ├── Makefile # Build configuration
├── Dockerfile # Docker configuration
├── docker-compose.yml # Docker Compose file
└── server.conf # Server configuration └── server.conf # Server configuration
``` ```
@@ -109,7 +126,7 @@ Carbon/
```bash ```bash
# Install dependencies # Install dependencies
sudo apt-get update sudo apt-get update
sudo apt-get install -y build-essential libssl-dev libmagic-dev libnghttp2-dev sudo apt-get install -y build-essential libssl-dev libmagic-dev libnghttp2-dev zlib1g-dev pkg-config
# Clone and build # Clone and build
git clone https://github.com/Azreyo/Carbon.git git clone https://github.com/Azreyo/Carbon.git
@@ -117,15 +134,15 @@ cd Carbon
make make
# Setup directories # Setup directories
mkdir -p certs log www mkdir -p ssl/cert ssl/key log www
# Generate test certificates # Generate test certificates
openssl req -x509 -nodes -days 365 -newkey rsa:4096 \ openssl req -x509 -nodes -days 365 -newkey rsa:4096 \
-keyout certs/key.pem -out certs/cert.pem \ -keyout ssl/key/key.key -out ssl/cert/cert.pem \
-subj "/C=US/ST=State/L=City/O=Carbon/CN=localhost" -subj "/C=US/ST=State/L=City/O=Carbon/CN=localhost"
# Run server # Run server
sudo ./server ./server
``` ```
### Build Options ### Build Options
@@ -135,6 +152,78 @@ make # Standard build (-O2 optimization)
make debug # Debug build with symbols (-g -O0) make debug # Debug build with symbols (-g -O0)
make release # Release build with optimizations (-O3) make release # Release build with optimizations (-O3)
make clean # Remove build artifacts make clean # Remove build artifacts
make install-deps # Install all dependencies
```
### Docker Deployment
Carbon includes full Docker support for containerized deployment:
#### Using Docker Compose (Recommended)
```bash
# Start the server
docker-compose up -d
# View logs
docker-compose logs -f
# Stop the server
docker-compose down
```
#### Manual Docker Build
```bash
# Build the image
docker build -t carbon-server .
# Run the container
docker run -d \
--name carbon \
-p 8080:8080 \
-p 8443:8443 \
-e PORT=8080 \
-e USE_HTTPS=false \
-e ENABLE_HTTP2=false \
-e ENABLE_WEBSOCKET=false \
-e MAX_THREADS=4 \
carbon-server
```
#### Using Pre-built Image
```bash
# Pull from Docker Hub
docker pull azreyo/carbon:latest
# Run the container
docker run -d -p 8080:8080 azreyo/carbon:latest
```
#### Docker Environment Variables
| Variable | Default | Description |
|----------|---------|-------------|
| `SERVER_NAME` | 0.0.0.0 | Server hostname or IP |
| `PORT` | 8080 | Server port |
| `USE_HTTPS` | false | Enable HTTPS |
| `ENABLE_HTTP2` | false | Enable HTTP/2 |
| `ENABLE_WEBSOCKET` | false | Enable WebSocket |
| `MAX_THREADS` | 4 | Worker threads |
| `VERBOSE` | true | Verbose logging |
#### Docker Volumes
Mount volumes for persistent data:
```bash
docker run -d \
-v /path/to/www:/app/www \
-v /path/to/ssl:/app/ssl \
-v /path/to/logs:/app/log \
-p 8080:8080 \
azreyo/carbon:latest
``` ```
### Production Setup ### Production Setup
@@ -170,44 +259,39 @@ Carbon uses a Linux-style configuration file (`server.conf`) with `key = value`
| Option | Type | Default | Description | | Option | Type | Default | Description |
|--------|------|---------|-------------| |--------|------|---------|-------------|
| `port` | integer | 8080 | HTTP port to listen on | | `port` | integer | 8080 | HTTP/HTTPS port to listen on |
| `https_port` | integer | 443 | HTTPS port to listen on |
| `use_https` | boolean | false | Enable HTTPS | | `use_https` | boolean | false | Enable HTTPS |
| `server_name` | string | localhost | Server hostname or IP | | `server_name` | string | 127.0.0.1 | Server hostname or IP |
#### Protocol Settings #### Protocol Settings
| Option | Type | Default | Description | | Option | Type | Default | Description |
|--------|------|---------|-------------| |--------|------|---------|-------------|
| `enable_http2` | boolean | true | Enable HTTP/2 (requires HTTPS) | | `enable_http2` | boolean | false | Enable HTTP/2 (requires HTTPS) |
| `enable_websocket` | boolean | true | Enable WebSocket support | | `enable_websocket` | boolean | false | Enable WebSocket support |
#### Performance Settings #### Performance Settings
| Option | Type | Default | Description | | Option | Type | Default | Description |
|--------|------|---------|-------------| |--------|------|---------|-------------|
| `max_threads` | integer | 4 | Number of worker threads | | `max_threads` | integer | 4 | Number of worker threads |
| `keep_alive_timeout` | integer | 60 | Keep-alive timeout in seconds | | `max_connections` | integer | 1024 | Maximum concurrent connections |
| `max_connections` | integer | 1000 | Maximum concurrent connections |
#### Path Settings
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `www_path` | string | www | Web root directory |
| `ssl_cert_path` | string | ssl/cert/cert.pem | Path to SSL certificate |
| `ssl_key_path` | string | ssl/key/key.key | Path to SSL private key |
#### Logging Settings #### Logging Settings
> ⚠️ Work in progress
| Option | Type | Default | Description | | Option | Type | Default | Description |
|--------|------|---------|-------------| |--------|------|---------|-------------|
| `log_file` | string | log/server.log | Path to log file | | `log_file` | string | log/server.log | Path to log file |
| `verbose` | boolean | false | Enable verbose logging | | `verbose` | boolean | false | Enable verbose logging |
| `running` | boolean | true | Server running state |
#### Security Settings
> ⚠️ Work in progress
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `rate_limit` | integer | 100 | Requests per IP per minute |
| `enable_hsts` | boolean | true | Enable HSTS header |
| `enable_csp` | boolean | true | Enable CSP header |
### Boolean Value Formats ### Boolean Value Formats
@@ -220,31 +304,40 @@ Values can be quoted with single or double quotes.
### Example Configuration ### Example Configuration
```conf ```conf
# Carbon Web Server Configuration # Carbon Web Server Configuration File
# Lines starting with # are comments
# Network # Server running state
running = true
# ---Network configuration---
# Server listening port
port = 8080 port = 8080
https_port = 443 # Enable HTTPS (requires valid certificates)
use_https = true use_https = false
server_name = example.com # Enable HTTP/2 support (requires HTTPS)
enable_http2 = false
# Enable WebSocket support
enable_websocket = false
# Server name or IP address
server_name = Your_domain/IP
# Protocols # ---Performance configuration---
enable_http2 = true # Maximum number of worker threads
enable_websocket = true max_threads = 4
max_connections = 1024
# Performance # ---Path configuration---
max_threads = 8 # Log file location
keep_alive_timeout = 60 log_file = log/server.log
max_connections = 2000 # Enable verbose logging
verbose = true
# Logging # Path to www directory
log_file = /var/log/carbon/server.log www_path = www
verbose = false # Path to public SSL certificate
ssl_cert_path = ssl/cert/cert.pem
# Security # Path to private SSL key
rate_limit = 100 ssl_key_path = ssl/key/key.key
enable_hsts = true
enable_csp = true
``` ```
--- ---
@@ -584,27 +677,28 @@ Carbon uses OpenSSL for SSL/TLS encryption:
- **Protocol Support**: TLS 1.2 and TLS 1.3 - **Protocol Support**: TLS 1.2 and TLS 1.3
- **Cipher Suites**: Modern, secure ciphers only - **Cipher Suites**: Modern, secure ciphers only
- **Perfect Forward Secrecy**: ECDHE key exchange - **Perfect Forward Secrecy**: ECDHE key exchange
- **Certificate Validation**: Proper certificate chain validation - **ALPN Support**: Protocol negotiation for HTTP/2
### Security Headers ### Security Headers
Automatically added security headers: Automatically added security headers:
``` ```
Content-Security-Policy: default-src 'self'
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-Content-Type-Options: nosniff X-Content-Type-Options: nosniff
X-Frame-Options: DENY X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block X-XSS-Protection: 1; mode=block
Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline' https://fonts.googleapis.com; font-src 'self' https://fonts.gstatic.com; script-src 'self' 'unsafe-inline';
``` ```
### Rate Limiting ### Rate Limiting
Per-IP rate limiting prevents abuse: Dynamic per-IP rate limiting prevents abuse:
- **Default**: 100 requests per IP per minute - **Default**: 500 requests per IP per minute (CPU-based adaptive)
- **Configurable**: Adjust via `rate_limit` setting - **Algorithm**: Dynamic calculation based on CPU cores
- **Automatic Blocking**: Exceeding limit returns 429 Too Many Requests - **Window**: 60-second rolling window
- **Response**: HTTP 429 Too Many Requests when exceeded
- **Memory Efficient**: Per-IP tracking with automatic cleanup
### Input Sanitization ### Input Sanitization
@@ -614,15 +708,20 @@ Protection against common attacks:
- **Directory Escapes**: Blocks `..` sequences - **Directory Escapes**: Blocks `..` sequences
- **Null Bytes**: Rejects null bytes in requests - **Null Bytes**: Rejects null bytes in requests
- **Buffer Overflows**: Bounds checking on all buffers - **Buffer Overflows**: Bounds checking on all buffers
- **Header Validation**: Strict HTTP header parsing
- **URL Encoding**: Proper URL decoding and validation
### Memory Safety ### Memory Safety
Memory management practices: Memory management practices:
- **Bounds Checking**: All buffer operations checked - **Bounds Checking**: All buffer operations validated
- **Leak Prevention**: Proper resource cleanup - **Leak Prevention**: Comprehensive resource cleanup
- **Use-After-Free**: Careful pointer management - **Stack Protection**: -fstack-protector-strong enabled
- **Integer Overflow**: Validation of size calculations - **PIE/ASLR**: Position Independent Executable
- **RELRO**: Full RELRO for GOT protection
- **Format String Protection**: -Wformat-security enforcement
- **Integer Overflow**: Careful size calculations and validation
### Best Practices ### Best Practices
@@ -652,9 +751,20 @@ max_threads = 16
```conf ```conf
# Increase for high-traffic sites # Increase for high-traffic sites
max_connections = 10000 max_connections = 10000
keep_alive_timeout = 120
``` ```
### Performance Features
Carbon includes several performance optimizations:
1. **Memory-Mapped File Caching**: Files up to 10MB are cached using mmap for fast access
2. **Buffer Pooling**: Reusable buffer pool reduces memory allocation overhead
3. **Zero-Copy Transfers**: Uses `sendfile()` for efficient file serving
4. **Gzip Compression**: Dynamic compression for text-based content
5. **CPU Affinity**: Thread-to-core pinning for better cache utilization
6. **Dynamic Rate Limiting**: CPU-based adaptive rate limiting (default: 500 requests/minute)
7. **Task Queue**: Lock-free queue design for worker thread distribution
### System Limits ### System Limits
Increase system limits for high concurrency: Increase system limits for high concurrency:
@@ -670,19 +780,18 @@ net.ipv4.tcp_max_syn_backlog = 65536
net.ipv4.ip_local_port_range = 10000 65535 net.ipv4.ip_local_port_range = 10000 65535
``` ```
### File Caching ### Performance Constants
Enable file caching for static content: The following performance constants are defined in the source code:
- Frequently accessed files cached in memory
- Reduces disk I/O overhead
- Automatic cache invalidation
### Zero-Copy Transfers - **SOCKET_SEND_BUFFER_SIZE**: 512KB
- **SOCKET_RECV_BUFFER_SIZE**: 512KB
Carbon uses `sendfile()` for efficient file transfers: - **SOCKET_BACKLOG**: 256 connections
- Eliminates user-space copies - **EPOLL_TIMEOUT**: 50ms for responsive polling
- Reduces CPU usage - **FILE_BUFFER_SIZE**: 64KB for file operations
- Improves throughput - **MAX_MMAP_FILE_SIZE**: 10MB maximum file size for mmap caching
- **WORKER_QUEUE_SIZE**: 2048 pending connections
- **RATE_LIMIT_WINDOW**: 60 seconds
### Benchmarking ### Benchmarking
@@ -809,17 +918,27 @@ git clone https://github.com/Azreyo/Carbon.git
cd Carbon cd Carbon
# Install development dependencies # Install development dependencies
sudo apt-get install -y build-essential libssl-dev libmagic-dev libnghttp2-dev sudo apt-get install -y build-essential libssl-dev libmagic-dev libnghttp2-dev zlib1g-dev pkg-config
# Build # Build
make make
# Run tests # Or use specific build type
make test make debug # Debug build with symbols
make release # Optimized release build
``` ```
### Code Structure ### Code Structure
The Carbon server is organized into modular components:
- **server.c**: Main server logic, epoll event loop, client handling
- **server_config.c/h**: Configuration structure and defaults
- **config_parser.c**: Configuration file parsing logic
- **http2.c/h**: HTTP/2 protocol implementation (nghttp2 wrapper)
- **websocket.c/h**: WebSocket protocol implementation (RFC 6455)
- **performance.c/h**: Performance optimizations (mmap cache, buffer pool, task queue)
#### Adding New Features #### Adding New Features
1. **Define interface** in appropriate header file 1. **Define interface** in appropriate header file

137
README.md
View File

@@ -53,10 +53,15 @@ Carbon is a modern, production-ready HTTP/HTTPS server implementation in C, desi
### 🚀 High Performance ### 🚀 High Performance
- **Asynchronous I/O**: Epoll-based event handling for maximum efficiency - **Asynchronous I/O**: Epoll-based event handling for maximum efficiency
- **Thread Pool**: Efficient connection handling with configurable worker threads - **Thread Pool**: Efficient connection handling with configurable worker threads
- **Smart Caching**: File caching system to reduce disk I/O - **Memory-Mapped Files**: mmap-based file caching for frequently accessed files (up to 10MB)
- **Buffer Pooling**: Reusable buffer pool to reduce memory allocations
- **Smart Caching**: Multi-level file caching system to reduce disk I/O
- **SendFile Optimization**: Zero-copy file transfers for better throughput - **SendFile Optimization**: Zero-copy file transfers for better throughput
- **Gzip Compression**: Dynamic compression for text-based content
- **Keep-Alive Support**: Persistent connections to reduce overhead - **Keep-Alive Support**: Persistent connections to reduce overhead
- **TCP Optimization**: Fine-tuned NODELAY and buffer configurations - **TCP Optimization**: Fine-tuned NODELAY, TCP_QUICKACK, and buffer configurations
- **CPU Affinity**: Thread-to-core pinning for better cache utilization
- **Dynamic Rate Limiting**: CPU-based adaptive rate limiting
### 🔒 High Security ### 🔒 High Security
- **SSL/TLS Support**: Full HTTPS support with modern cipher suites - **SSL/TLS Support**: Full HTTPS support with modern cipher suites
@@ -130,17 +135,49 @@ make # Standard build
make debug # Debug build with symbols make debug # Debug build with symbols
make release # Optimized release build make release # Optimized release build
make clean # Clean build artifacts make clean # Clean build artifacts
make install-deps # Install all dependencies
``` ```
### Using Docker
Carbon includes full Docker support for easy deployment:
```bash
# Using Docker Compose (recommended)
docker-compose up -d
# Or build and run manually
docker build -t carbon-server .
docker run -d -p 8080:8080 -p 8443:8443 \
-e PORT=8080 \
-e USE_HTTPS=false \
-e ENABLE_HTTP2=false \
-e ENABLE_WEBSOCKET=false \
carbon-server
# Using the official image
docker pull azreyo/carbon:latest
docker run -d -p 8080:8080 azreyo/carbon:latest
```
**Docker Environment Variables:**
- `SERVER_NAME`: Server domain/IP (default: 0.0.0.0)
- `PORT`: Server port (default: 8080)
- `USE_HTTPS`: Enable HTTPS (default: false)
- `ENABLE_HTTP2`: Enable HTTP/2 (default: false)
- `ENABLE_WEBSOCKET`: Enable WebSocket (default: false)
- `MAX_THREADS`: Worker threads (default: 4)
- `VERBOSE`: Verbose logging (default: true)
### Manual Compilation ### Manual Compilation
If you prefer manual compilation: If you prefer manual compilation:
```bash ```bash
gcc src/server.c src/config_parser.c src/server_config.c src/websocket.c src/http2.c -o server \ gcc src/server.c src/config_parser.c src/server_config.c src/websocket.c src/http2.c src/performance.c -o server \
-D_GNU_SOURCE \ -D_GNU_SOURCE \
-Wall -Wextra -O2 \ -Wall -Wextra -O2 \
-lssl -lcrypto -lpthread -lmagic -lnghttp2 -lssl -lcrypto -lpthread -lmagic -lnghttp2 -lz
``` ```
## ⚙️ Configuration ## ⚙️ Configuration
@@ -151,7 +188,7 @@ gcc src/server.c src/config_parser.c src/server_config.c src/websocket.c src/htt
```bash ```bash
# Create certificates directory # Create certificates directory
mkdir -p ssl ssl/certs ssl/key mkdir -p ssl/cert ssl/key
# Generate self-signed certificate (for testing only) # Generate self-signed certificate (for testing only)
openssl req -x509 -newkey rsa:2048 \ openssl req -x509 -newkey rsa:2048 \
@@ -169,46 +206,53 @@ Create or edit `server.conf` in the project root. Carbon uses a traditional Linu
# Carbon Web Server Configuration File # Carbon Web Server Configuration File
# Lines starting with # are comments # Lines starting with # are comments
# Server listening port
port = 443
# Enable HTTPS (requires valid certificates in certs/ directory)
use_https = true
# Log file location
log_file = log/server.log
# Maximum number of worker threads
max_threads = 4
# Server running state # Server running state
running = true running = true
# Server name or IP address (used for logging and response headers) # ---Network configuration---
server_name = 10.0.0.206 # Server listening port
port = 8080
# Enable verbose logging # Enable HTTPS (requires valid certificates in certs/ directory)
verbose = true use_https = false
# Enable HTTP/2 support (requires HTTPS) # Enable HTTP/2 support (requires HTTPS)
enable_http2 = true enable_http2 = false
# Enable WebSocket support # Enable WebSocket support
enable_websocket = false enable_websocket = false
# Server name or IP address (used for logging and response headers)
server_name = Your_domain/IP
# ---Performance configuration---
# Maximum number of worker threads
max_threads = 4
max_connections = 1024
# ---Path configuration---
# Log file location
log_file = log/server.log
# Enable verbose logging
verbose = true
# Path to www directory
www_path = www
# Path to public ssl certificate
ssl_cert_path = ssl/cert/cert.pem
# Path to private ssl key
ssl_key_path = ssl/key/key.key
``` ```
**Configuration Options:** **Configuration Options:**
- `port`: HTTP port (default: 8080) - `running`: Server running state (default: true)
- `port`: HTTP/HTTPS port (default: 8080)
- `use_https`: Enable HTTPS - accepts: true/false, yes/no, on/off, 1/0 (requires SSL certificates) - `use_https`: Enable HTTPS - accepts: true/false, yes/no, on/off, 1/0 (requires SSL certificates)
- `https_port`: HTTPS port (default: 443) - `enable_http2`: Enable HTTP/2 support (requires HTTPS and ALPN, default: false)
- `enable_http2`: Enable HTTP/2 support (requires HTTPS and ALPN) - `enable_websocket`: Enable WebSocket support (default: false)
- `enable_websocket`: Enable WebSocket support (default: true)
- `log_file`: Path to log file
- `max_threads`: Number of worker threads
- `server_name`: Your domain or IP address - `server_name`: Your domain or IP address
- `max_threads`: Number of worker threads (default: 4)
- `max_connections`: Maximum concurrent connections (default: 1024)
- `log_file`: Path to log file (default: log/server.log)
- `verbose`: Enable detailed logging - accepts: true/false, yes/no, on/off, 1/0 - `verbose`: Enable detailed logging - accepts: true/false, yes/no, on/off, 1/0
- `ssl_cert_path`: Path to ssl certificate - `www_path`: Path to web root directory (default: www)
- `ssl_key_path`: Path to ssl key - `ssl_cert_path`: Path to SSL certificate file (default: ssl/cert/cert.pem)
- `ssl_key_path`: Path to SSL private key file (default: ssl/key/key.key)
**Note:** Boolean values are flexible and accept multiple formats: **Note:** Boolean values are flexible and accept multiple formats:
- True: `true`, `yes`, `on`, `1` - True: `true`, `yes`, `on`, `1`
@@ -410,14 +454,23 @@ Carbon/
│ ├── websocket.c # WebSocket implementation │ ├── websocket.c # WebSocket implementation
│ ├── websocket.h # WebSocket headers │ ├── websocket.h # WebSocket headers
│ ├── http2.c # HTTP/2 implementation │ ├── http2.c # HTTP/2 implementation
│ └── http2.h # HTTP/2 headers │ ├── http2.h # HTTP/2 headers
│ ├── performance.c # Performance optimizations
│ ├── performance.h # Performance headers
│ └── bin/ # Compiled object files
├── Makefile # Build configuration ├── Makefile # Build configuration
├── Dockerfile # Docker container configuration
├── docker-compose.yml # Docker Compose configuration
├── docker-push.sh # Docker image push script
├── server.conf # Server configuration file (Linux-style) ├── server.conf # Server configuration file (Linux-style)
├── README.md # This file ├── README.md # This file
├── DOCUMENTATION.md # Comprehensive documentation
├── LICENSE # MIT License ├── LICENSE # MIT License
├── certs/ # SSL certificates (create this) ├── ssl/ # SSL certificates directory (create this)
│ ├── cert.pem │ ├── cert/
│ └── key.pem │ │ └── cert.pem # SSL certificate
│ └── key/
│ └── key.key # SSL private key
├── www/ # Web root directory ├── www/ # Web root directory
│ ├── index.html │ ├── index.html
│ └── websocket-test.html # WebSocket test client │ └── websocket-test.html # WebSocket test client
@@ -432,14 +485,18 @@ Carbon/
| HTTP/2 Support | High | ✅ Implemented | | HTTP/2 Support | High | ✅ Implemented |
| WebSocket Support | High | ✅ Implemented | | WebSocket Support | High | ✅ Implemented |
| Secure WebSocket (wss://) | High | ✅ Implemented | | Secure WebSocket (wss://) | High | ✅ Implemented |
| API Rate Limiting | High | ⚠️ Broken (WIP) | | API Rate Limiting | High | ✅ Implemented |
| Security Headers | High | ✅ Implemented | | Security Headers | High | ✅ Implemented |
| Memory Leak Prevention | High | ✅ Implemented | | Memory Leak Prevention | High | ✅ Implemented |
| Performance Optimizations | High | ✅ Implemented |
| File Caching (mmap) | High | ✅ Implemented |
| Buffer Pooling | High | ✅ Implemented |
| Docker Support | Medium | ✅ Implemented |
| Gzip Compression | Medium | ✅ Implemented |
| User Authentication | High | 📋 Planned | | User Authentication | High | 📋 Planned |
| Reverse Proxy Mode | Medium | 📋 Planned | | Reverse Proxy Mode | Medium | 📋 Planned |
| Load Balancing | Low | 📋 Planned | | Load Balancing | Low | 📋 Planned |
| Docker Support | Medium | 📋 Planned | | Comprehensive API Docs | Medium | 🔄 In Progress |
| Comprehensive API Docs | Medium | <20> In Progress |
## 🤝 Contributing ## 🤝 Contributing