sozu/bin
Emmanuel Bosquet 863dc9bfcf bump dependencies for 1.0.6 2024-11-20 15:22:25 +01:00
..
src function main returns exit status 2024-08-09 12:21:00 +02:00
Cargo.toml bump dependencies for 1.0.6 2024-11-20 15:22:25 +01:00
README.md document protobuf in the sozu-command-lib README 2023-05-03 15:05:33 +02:00
build.rs Use clippy with Rust 1.67.0 and format source code 2023-02-06 18:15:04 +01:00
config.toml chore: update configuration file 2024-04-16 09:45:21 +02:00

README.md

sozu, a HTTP proxy

This project wraps the sozu_lib library to make it scalable and dynamically configured. Each single threaded event loop is started in a worker process that receives configuration commands through anonymous unix sockets.

This executable requires a configuration file in the TOML format, that describes the worker types and numbers, along with global information. This file can describe clusters handled by the proxy, but it is more recommended to use the command unix socket, through which the proxy listens for orders or configuration changes. The path of that unix socket is set in the configuration file.

Command socket message format

The proxy receives orders through a unix socket. The path to this unix socket can be defined by the command_socket option in the TOML configuration file.

The messages are sent as binary, using protobuf, separated by the 0 byte.

Their format is defined in ../command/command.proto. Additionally, the provides the necessary channels to communicate with the command socket.