From 788f7fd4ea17e53a3a04b4604a19acfdec0e6242 Mon Sep 17 00:00:00 2001 From: Ara Sadoyan Date: Fri, 8 May 2026 13:03:17 +0200 Subject: [PATCH] README update --- README.md | 105 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 61 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 3169068..2507183 100644 --- a/README.md +++ b/README.md @@ -50,32 +50,30 @@ Built on Rust, on top of **Cloudflare’s Pingora engine**, **Aralez** delivers ### `main.yaml` -| Key | Example Value | Description | -|----------------------------------|--------------------------------------|----------------------------------------------------------------------------------------------------| -| **threads** | 12 | Number of running daemon threads. Optional, defaults to 1 | -| **runuser** | aralez | Optional, Username for running aralez after dropping root privileges, requires to launch as root | -| **rungroup** | aralez | Optional,Group for running aralez after dropping root privileges, requires to launch as root | -| **daemon** | false | Run in background (boolean) | -| **upstream_keepalive_pool_size** | 500 | Pool size for upstream keepalive connections | -| **pid_file** | /tmp/aralez.pid | Path to PID file | -| **error_log** | /tmp/aralez_err.log | Path to error log file | -| **upgrade_sock** | /tmp/aralez.sock | Path to live upgrade socket file | -| **config_address** | 0.0.0.0:3000 | HTTP API address for pushing upstreams.yaml from remote location | -| **config_tls_address** | 0.0.0.0:3001 | HTTPS API address for pushing upstreams.yaml from remote location | -| **config_tls_certificate** | etc/server.crt | Certificate file path for API. Mandatory if proxy_address_tls is set, else optional | -| **proxy_tls_grade** | (high, medium, unsafe) | Grade of TLS ciphers, for easy configuration. High matches Qualys SSL Labs A+ (defaults to medium) | -| **config_tls_key_file** | etc/key.pem | Private Key file path. Mandatory if proxy_address_tls is set, else optional | -| **proxy_address_http** | 0.0.0.0:6193 | Aralez HTTP bind address | -| **proxy_address_tls** | 0.0.0.0:6194 | Aralez HTTPS bind address (Optional) | -| **proxy_configs** | etc/ | The top directory of config files | -| **upstreams_conf** | etc/upstreams.yaml | The location of upstreams file | -| **log_level** | info | Log level , possible values : info, warn, error, debug, trace, off | -| **hc_method** | HEAD | Healthcheck method (HEAD, GET, POST are supported) UPPERCASE | -| **hc_interval** | 2 | Interval for health checks in seconds | -| **master_key** | 5aeff7f9-7b94-447c-af60-e8c488544a3e | Master key for working with API server and JWT Secret generation | -| **file_server_folder** | /some/local/folder | Optional, local folder to serve | -| **file_server_address** | 127.0.0.1:3002 | Optional, Local address for file server. Can set as upstream for public access | -| **config_api_enabled** | true | Boolean to enable/disable remote config push capability | +| Key | Example Value | Description | +|----------------------------------|------------------------|----------------------------------------------------------------------------------------------------| +| **threads** | 12 | Number of running daemon threads. Optional, defaults to 1 | +| **runuser** | aralez | Optional, Username for running aralez after dropping root privileges, requires to launch as root | +| **rungroup** | aralez | Optional,Group for running aralez after dropping root privileges, requires to launch as root | +| **daemon** | false | Run in background (boolean) | +| **upstream_keepalive_pool_size** | 500 | Pool size for upstream keepalive connections | +| **pid_file** | /tmp/aralez.pid | Path to PID file | +| **error_log** | /tmp/aralez_err.log | Path to error log file | +| **upgrade_sock** | /tmp/aralez.sock | Path to live upgrade socket file | +| **config_address** | 0.0.0.0:3000 | HTTP API address for pushing upstreams.yaml from remote location | +| **proxy_tls_grade** | (high, medium, unsafe) | Grade of TLS ciphers, for easy configuration. High matches Qualys SSL Labs A+ (defaults to medium) | +| **config_tls_key_file** | etc/key.pem | Private Key file path. Mandatory if proxy_address_tls is set, else optional | +| **proxy_address_http** | 0.0.0.0:6193 | Aralez HTTP bind address | +| **proxy_address_tls** | 0.0.0.0:6194 | Aralez HTTPS bind address (Optional) | +| **proxy_configs** | etc/ | The top directory of config files | +| **upstreams_conf** | etc/upstreams.yaml | The location of upstreams file | +| **log_level** | info | Log level , possible values : info, warn, error, debug, trace, off | +| **hc_method** | HEAD | Healthcheck method (HEAD, GET, POST are supported) UPPERCASE | +| **hc_interval** | 2 | Interval for health checks in seconds | +| **master_key** | Random long string | Master key for working with API server and JWT Secret generation | +| **file_server_folder** | /some/local/folder | Optional, local folder to serve | +| **file_server_address** | 127.0.0.1:3002 | Optional, Local address for file server. Can set as upstream for public access | +| **config_api_enabled** | true | Boolean to enable/disable remote config push capability | --- @@ -124,20 +122,39 @@ For getting the best performance on newer hardware use `aralez-x86_64-*.gz`. ./aralez -c path/to/main.yaml ``` -## 🔌 Systemd integration +## Systemd integration + +Assuming Arales in installed in `/opt/aralez` folder ```bash cat > /etc/systemd/system/aralez.service <