# СBLT

![cblt](https://github.com/evgenyigumnov/cblt/raw/HEAD/logo.png)

Safe and fast minimalistic web server, written in Rust, that serves files from a directory and proxies requests to another server.

## Project Name Explanation 

The name **Cblt** appears to be a good shortened version of **Cobalt**. It retains the association with the element and strength, while also looking modern and minimalist. 

## Features

- Serve files from a directory
  - **10 times faster than Nginx for small content under 100KB**
  - Range requests for static files
  - Gzip compression
  - Mime types
- Proxy requests to another server
  - **Native Docker integration via labels**
  - Load Balancer (Round Robin, IP Hash, **reactive health check on demand**)
  - Websocket support
- Reload configuration without restarting
- TLS support
- Redirects
- KDL Document Language configuration (**Cbltfile**)


## Quick Start
You can run Cblt with Cargo or Docker.
### Cargo
Install:
```bash
cargo install cblt
```
Run:
```bash
cblt
```

### Docker
```bash
docker run -d -p 80:80 -p 443:443 --restart unless-stopped --name cblt ievkz/cblt
```
**Volumes**:
- -v /your/path/Cbltfile:/cblt/etc/Cbltfile  # Cbltfile configuration if you would like to replace [default config](https://github.com/evgenyigumnov/cblt/blob/main/Cbltfile)
- -v /your/path/assets:/cblt/assets # Folder with your static content (index.html and etc)


### Test

```
curl -H "Host: example.com"  http://127.0.0.1/
curl --insecure https:/127.0.0.1/
curl -X POST http://127.0.0.1/api/entry \
-H "User-Agent: curl/7.68.0" \
-H "Accept: */*" \
-H "Content-Type: application/json" \
-d '{"key":"value"}'
curl -v -H "Range: bytes=0-499" http://127.0.0.1/logo.png
```

## "Cbltfile" configuration examples
### File server
```kdl
"*:80" {
    root "*" "/path/to/folder"
    file_server
}
```
### File server & Proxy
```kdl
"127.0.0.1:8080" {
    reverse_proxy "/test-api/*" "http://10.8.0.3:80"
    root "*" "/path/to/folder"
    file_server
}
```
### TLS support ([docs](https://github.com/evgenyigumnov/cblt/blob/main/tls.md))
```kdl
"example.com" {
    root "*" "/path/to/folder"
    file_server
    tls "/path/to/your/domain.crt" "/path/to/your/domain.key"
}
```
### Redirect
```kdl
"*:80" {
    redir "https://127.0.0.1{uri}"
}
```

### Load Balancer
```kdl
"*:80" {
    reverse_proxy "/http/*" "http://127.0.0.1:8080" "http://127.0.0.1:8081" {
      lb_interval "60s"
      lb_timeout "1s"
      lb_retries "2"
      lb_policy "round_robin"  //  "ip_hash"
    }
    root "*" "./assets"
    file_server
}
```
### Native Docker integration via labels
docker-compose.yml (for backend)
```yaml
version: '3.8'
services:
  backend:
    image: backend_image:version
    networks:
      - app
    deploy:
      mode: replicated
      replicas: 3
      labels:
        - "cblt.hosts=domain.org"
        - "cblt.path=/api/*"
        - "cblt.port=9000"
        - "cblt.lb_policy=round_robin"
        - "cblt.lb_interval=60s"
        - "cblt.lb_timeout=1s"
        - "cblt.lb_retries=2"
#        - "cblt.secrets=domain.org secret_key_org_2024 secret_cert_org_2024"
      restart_policy:
        condition: on-failure
    ports:
      - "9000:9000"
networks:
  app:
    external: true
```
Launch CBLT in Docker integration mode
```bash
docker run -d -v /var/run/docker.sock:/var/run/docker.sock -p 80:80 -p 443:443 --restart unless-stopped --name cblt ievkz/cblt
```


## Benchmark
Do test with Apache Benchmark (ab) for 3000 requests with 1000 concurrent connections. Download 23kb image from 127.0.0.1/logo.png

```bash
 ab -c 1000 -n 3000 http://127.0.0.1/logo.png
``` 

| Percent | Cblt | Nginx |
|---------|------|-------|
| 50%     | 179 | 1209  |
| 75%     | 194 | 1655  |
| 100%    | 200 | 2146  |

## Contributing
I would love to see contributions from the community. If you experience bugs, feel free to open an issue. If you would like to implement a new feature or bug fix, please follow the steps:

1. Do fork
2. Do some changes
3. Create pull request