Angie

https://en.angie.software/angie/docs/
Admin
Angie is an efficient, powerful, and scalable open-source web server forked from nginx, offering a...
Tokens:639,377
Snippets:4,381
Trust Score:9.3
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Start Angie with systemd

Source: https://en.angie.software/angie/docs/configuration/runtime/

Starts the Angie service using systemd. Use this command to launch Angie after installation.

```bash
$ sudo systemctl start angie
```

--------------------------------

### Sample log output for the logging macros example

Source: https://en.angie.software/angie/docs/developer_guide/

Shows the resulting log entries for the previous example: an info-level error log with the action and client details, and a debug-level log with mp4 start and length.

```text
2016/09/16 22:08:52 [info] 17445#0: *1 client prematurely closed connection while
sending mp4 to client, client: 127.0.0.1, server: , request: "GET /file.mp4 HTTP/1.1"
2016/09/16 23:28:33 [debug] 22140#0: *1 mp4 start:0, length:10000
```

--------------------------------

### Check configuration and start Angie

Source: https://en.angie.software/angie/docs/configuration/runtime/

Checks the configuration syntax with `angie -t` and, if successful, starts Angie. Recommended to run before starting to avoid errors.

```bash
$ sudo angie -t && sudo systemctl start angie
```

--------------------------------

### map hostnames masks example

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_map/

Shows how to use prefix and suffix masks with the hostnames parameter. The first record matches any subdomain of example.com, the second matches any host starting with 'example.'.

```nginx
*.example.com 1;
example.*     1;
```

--------------------------------

### Redis2 configuration example

Source: https://en.angie.software/angie/docs/configuration/modules/external-modules/redis2/

Full configuration example showing upstream definition and various locations for setting, getting, pipelining, and executing arbitrary Redis commands. Note that variables are not allowed in redis2_pass parameters.

```nginx
upstream redis_upstream {
    server 127.0.0.1:6379;
}

server {
    listen       80;
    server_name  localhost;

    # Set a key value
    location /foo {
        set $value 'first';
        redis2_query set one $value;
        redis2_pass redis_upstream;
    }

    # Get a value by key
    location /bar {
        redis2_query get one;
        redis2_pass redis_upstream;
    }

    # Set a key value from query parameters
    location /set {
        set_unescape_uri $key $arg_key;
        set_unescape_uri $val $arg_val;
        redis2_query set $key $val;
        redis2_pass 127.0.0.1:6379;
    }

    # Get a value by key from query parameters
    location /get {
        set_unescape_uri $key $arg_key;
        redis2_query get $key;
        redis2_pass 127.0.0.1:6379;
    }

    # Execute multiple pipelined commands
    location /pipeline {
        set $value 'first';
        redis2_query set one $value;
        redis2_query get one;
        redis2_query set one 'first first';
        redis2_query get one;
        redis2_pass 127.0.0.1:6379;
    }

    # Execute an arbitrary command passed in a query parameter
    location /cmd {
        set_unescape_uri $cmd $arg_command;
        redis2_raw_query "$cmd\r\n";
        redis2_pass 127.0.0.1:6379;
    }
}
```

--------------------------------

### Install the module

Source: https://en.angie.software/angie/docs/installation/external-modules/

Installs the compiled module to /etc/angie/modules/ with permissions 644.

```bash
$ sudo install -m 644 objs/ngx_http_fancyindex_module.so /etc/angie/modules/
```

--------------------------------

### Build and install Angie

Source: https://en.angie.software/angie/docs/installation/sourcebuild/

Compiles the source and installs Angie system-wide.

```bash
$ make
$ sudo make install
```

--------------------------------

### Copy ModSecurity configuration examples

Source: https://en.angie.software/angie/docs/configuration/modules/external-modules/modsecurity/

Commands to copy the required example configuration files for the core rules.

```bash
$ sudo cp coreruleset/crs-setup.conf.example coreruleset/crs-setup.conf
$ sudo cp coreruleset/rules/REQUEST-900-EXCLUSION-RULES-BEFORE-CRS.conf.example \
      coreruleset/rules/REQUEST-900-EXCLUSION-RULES-BEFORE-CRS.conf
$ sudo cp coreruleset/rules/RESPONSE-999-EXCLUSION-RULES-AFTER-CRS.conf.example \
      coreruleset/rules/RESPONSE-999-EXCLUSION-RULES-AFTER-CRS.conf
```

--------------------------------

### njs command-line utility examples

Source: https://en.angie.software/angie/docs/configuration/modules/external-modules/njs/

Examples of using the njs command-line utility. The first pipes an expression to njs with the -q flag, outputting the result. The second starts an interactive session and shows the global object.

```bash
$ echo "2**3" | njs -q
8
```

```bash
$ njs

>> globalThis
global {
 njs: njs {
  version: '0.3.9'
 },
 global: [Circular],
 process: process {
  argv: [
   '/usr/bin/njs'
  ],
...
```

--------------------------------

### Install octoDNS and Cloudflare provider

Source: https://en.angie.software/angie/docs/configuration/acme/

Creates a virtual environment and installs octoDNS with the Cloudflare provider.

```bash
$ sudo apt-get install python3-venv
$ sudo python3 -m venv /opt/octodns
$ sudo /opt/octodns/bin/pip install 'octodns>=1.16' octodns-cloudflare
```

--------------------------------

### Start Angie service and request default page

Source: https://en.angie.software/angie/docs/configuration/first-steps/

Start the Angie service with systemctl and request the default page with curl. The response shows the welcome-page server that the package ships.

```bash
$ sudo systemctl start angie
$ curl -I localhost
HTTP/1.1 200 OK
Server: Angie/1.12.4
...
```

--------------------------------

### Wasmtime configuration example

Source: https://en.angie.software/angie/docs/configuration/modules/wasm/wasm_wasmtime/

Example configuration for the Wasmtime module, setting stack size and enabling WASI, and loading a WASM module.

```nginx
wasm_modules {

    wasmtime_stack_size 8k;

    wasmtime_enable_wasi on;

    load fft_transform.wasm id=fft;
}
```

--------------------------------

### FreeBSD: Install Angie PRO package

Source: https://en.angie.software/angie/docs/installation/pro_packages/

Installs the Angie PRO package from the angie repository.

```bash
$ sudo pkg install -r angie -y angie-pro
```

--------------------------------

### js_shared_dict_zone configuration examples (example.conf)

Source: https://en.angie.software/angie/docs/configuration/modules/external-modules/http_js/

Configuration examples for the js_shared_dict_zone directive, showing various options: timeout, evict, type=number, and state for persistent dictionaries.

```nginx
example.conf:
    # Creates a 1MB dictionary with string values,
    # key-value pairs are removed after 60 seconds of inactivity:
    js_shared_dict_zone zone=foo:1M timeout=60s;

    # Creates a 512KB dictionary with string values,
    # oldest key-value pair is removed when the zone overflows:
    js_shared_dict_zone zone=bar:512K timeout=30s evict;

    # Creates a persistent 32KB dictionary with numeric values:
    js_shared_dict_zone zone=num:32k type=number;

    # Creates a 1MB dictionary with string values and persistent state:
    js_shared_dict_zone zone=persistent:1M state=/tmp/dict.json;
```

--------------------------------

### FreeBSD: Install Angie package

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Installs the Angie package from the angie repo.

```bash
$ sudo pkg install -r angie -y angie
```

--------------------------------

### OpenTracing configuration example with DataDog tracer

Source: https://en.angie.software/angie/docs/configuration/modules/external-modules/opentracing/

Example configuration enabling OpenTracing, loading the DataDog tracer plugin, and setting up a backend proxy with tracing tags and context propagation.

```nginx
http {
    opentracing on;

    opentracing_load_tracer /usr/local/lib/libdd_opentracing_plugin.so /etc/datadog-config.json;

    upstream backend {
        server app-service:9001;
    }

    server {
        error_log /var/log/angie/debug.log debug;
        listen 8080;
        server_name localhost;

        location = / {
            opentracing_trace_locations off;
            proxy_pass http://backend;
            opentracing_propagate_context;
            opentracing_tag "resource.name" "/";
        }
    }
}
```

--------------------------------

### openSUSE: Install Angie package

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Installs the Angie package using zypper.

```bash
$ sudo zypper install -y angie
```

--------------------------------

### WAMR configuration example

Source: https://en.angie.software/angie/docs/configuration/modules/wasm/wasm_wamr/

Example configuration for the WAMR module, setting heap and stack sizes and loading a WASM module with an id.

```nginx
wasm_modules {

    wamr_heap_size 16k;

    wamr_stack_size 16k;

    load fft_transform.wasm id=fft;
}
```

--------------------------------

### Install prerequisites on Debian/Ubuntu

Source: https://en.angie.software/angie/docs/installation/sourcebuild/

Installs the required build tools and libraries (gcc, make, PCRE2, zlib, OpenSSL) and curl for downloading the source code.

```bash
$ sudo apt install build-essential libpcre2-dev zlib1g-dev libssl-dev curl
```

--------------------------------

### Start Angie and synchronization

Source: https://en.angie.software/angie/docs/configuration/cluster/

Tests the Angie configuration and starts the Angie service, then runs the synchronization script. The script automatically checks the configuration, synchronizes with all nodes, and applies it.

```bash
$ sudo angie -t && sudo service angie start
```

```bash
$ sudo angiehasync -Sd
```

--------------------------------

### PostgreSQL module configuration example

Source: https://en.angie.software/angie/docs/configuration/modules/external-modules/postgres/

Example configuration for the PostgreSQL module, defining an upstream with postgres_server, and locations for create, insert, and select queries.

```nginx
http {
    upstream database {
        postgres_server 127.0.0.1 dbname=ang_test
                         user=ang_test password=ang_test;
    }

    server {
        listen 80;
        postgres_output text;

        location /create {
            postgres_pass database;
            postgres_query "CREATE TABLE cats (id integer, name text)";
        }

        location /insert {
            postgres_pass database;
            postgres_query "INSERT INTO cats (id, name) VALUES ($arg_id, '$arg_name')";
        }

        location /select {
            postgres_pass database;
            postgres_query "SELECT name FROM cats WHERE id=$arg_id";
        }
    }
}
```

--------------------------------

### dav_access Directive Example

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_dav/

Sets access permissions for newly created files and directories. The example shows specifying user, group, and all permissions.

```nginx
dav_access user:rw group:rw all:r;
```

--------------------------------

### Install Alpine prerequisites for Angie repo

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Update package index and install curl and ca-certificates on Alpine.

```bash
$ sudo apk update
$ sudo apk add curl ca-certificates
```

--------------------------------

### Install prerequisites for Angie repo (Debian/Ubuntu)

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Updates package lists and installs ca-certificates and curl for Debian/Ubuntu.

```bash
$ sudo apt-get update
$ sudo apt-get install -y ca-certificates curl
```

--------------------------------

### Install Angie package (ALT)

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Installs the Angie package using apt-get.

```bash
$ sudo apt-get install -y angie
```

--------------------------------

### MP4 pseudo-streaming request with start and end times

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_mp4/

Example URL showing how to specify both start and end times for playback using the 'start' and 'end' query arguments.

```http
http://example.com/elephants_dream.mp4?start=238.88&end=555.55
```

--------------------------------

### Create application directory and test file

Source: https://en.angie.software/angie/docs/configuration/first-steps/

Creates the /data/app directory and writes an index.html file with the text 'Hello from the application'. The output shows the file content.

```bash
$ sudo mkdir -p /data/app
$ echo 'Hello from the application' | sudo tee /data/app/index.html
Hello from the application
```

--------------------------------

### zlib deflate and inflate example

Source: https://en.angie.software/angie/docs/configuration/njs-reference/

Shows how to compress and decompress a string using zlib.deflateSync and zlib.inflateSync. The example outputs the original string after decompression.

```javascript
import zlib from 'zlib';

const deflated = zlib.deflateSync('Hello World!');
const inflated = zlib.inflateSync(deflated);

console.log(inflated.toString()); // 'Hello World!'
```

--------------------------------

### MP4 pseudo-streaming request with start time

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_mp4/

Example URL showing how a media player requests an MP4 file with a start time in seconds using the 'start' query argument.

```http
http://example.com/elephants_dream.mp4?start=238.88
```

--------------------------------

### ALT: Create apt configuration for Angie PRO repository

Source: https://en.angie.software/angie/docs/installation/pro_packages/

Creates an apt configuration file that specifies the SSL certificate and key for the Angie PRO repository.

```bash
$ ( echo 'Acquire::https::Verify-Peer "true";';
    echo 'Acquire::https::Verify-Host "true";';
    echo 'Acquire::https::SslCert     "/etc/ssl/angie/angie-repo.crt";';
    echo 'Acquire::https::SslKey      "/etc/ssl/angie/angie-repo.key";';
  )  | sudo tee -a /etc/apt/apt.conf >/dev/null
```

--------------------------------

### HTML output format example

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_autoindex/

Example of the HTML directory listing output, showing file names, sizes, and modification times.

```html
<html>
<head>
    <title>Index of /files/</title>
</head>
<body>
    <h1>Index of /files/</h1>
    <hr>
    <pre>
            <a href="../">../</a>
            <a href="example.txt">example.txt</a>               12-Jun-2025 14:21    1234
            <a href="image.png">image.png</a>                   12-Jun-2025 14:21    4321
            </pre>
    <hr>
</body>
</html>
```

--------------------------------

### FreeBSD: Install extra packages

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Optional command to install extra Angie packages, replacing <PACKAGE NAME> with the desired package.

```bash
$ sudo pkg install -r angie -y <PACKAGE NAME>
```

--------------------------------

### Get server parameters with defaults=on

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_api/

Example of a GET request with the 'defaults=on' query argument to obtain default parameter values for a stream upstream server.

```bash
$ curl http://127.0.0.1/config/stream/upstreams/backend/servers/backend.example.com?defaults=on
```

--------------------------------

### Configure apt for Angie PRO repository (Astra SE)

Source: https://en.angie.software/angie/docs/installation/pro_packages/

Creates /etc/apt/apt.conf.d/90download-angie with SSL settings for the repository.

```bash
Acquire::https::download.angie.software::Verify-Peer "true";
Acquire::https::download.angie.software::Verify-Host "true";
Acquire::https::download.angie.software::SslCert     "/etc/ssl/angie/angie-repo.crt";
Acquire::https::download.angie.software::SslKey      "/etc/ssl/angie/angie-repo.key";
```

--------------------------------

### Angie configuration file structure example

Source: https://en.angie.software/angie/docs/configuration/configfile/

Shows the overall structure of an Angie configuration file with main context directive and contexts for events, http, stream. Includes comments and placeholder configurations for virtual servers and locations.

```nginx
user angie; # a directive in the 'main' context

events {

    # configuration of connection processing
}

http {

    # Configuration specific to HTTP and affecting all virtual servers

    server {

        # configuration of HTTP virtual server 1
        location /one {

            # configuration for processing URIs starting with '/one'
        }
        location /two {

            # configuration for processing URIs starting with '/two'
        }
    }

    server {

        # configuration of HTTP virtual server 2
    }
}

stream {

    # Configuration specific to TCP/UDP and affecting all virtual servers
    server {

        # configuration of TCP virtual server 1
    }
}
```

--------------------------------

### limit_except: Restrict HTTP methods in a location

Source: https://en.angie.software/angie/docs/configuration/modules/http/

Limits allowed HTTP methods inside a location. The example allows only GET and HEAD (since allowing GET also allows HEAD) from the 192.168.1.0/32 network, denying all other methods and clients. The restriction applies to all methods except GET and HEAD.

```nginx
limit_except GET {
  allow 192.168.1.0/32;
  deny  all;
}
```

--------------------------------

### RealIP Configuration Example

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_realip/

Example configuration for the RealIP module, setting trusted addresses and the header field to use for client address replacement.

```nginx
set_real_ip_from  192.168.1.0/24;
set_real_ip_from  192.168.2.1;
set_real_ip_from  2001:0db8::/32;
real_ip_header    X-Forwarded-For;
real_ip_recursive on;
```

--------------------------------

### openSUSE: Install extra packages

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Optional command to install extra Angie packages, replacing <PACKAGE NAME> with the desired package.

```bash
$ sudo zypper install -y <PACKAGE NAME>
```

--------------------------------

### Install prerequisites on RHEL/Fedora

Source: https://en.angie.software/angie/docs/installation/sourcebuild/

Installs the required build tools and libraries (gcc, make, pcre2-devel, zlib-devel, openssl-devel) on RHEL, Fedora, and derivatives.

```bash
$ sudo dnf install gcc make pcre2-devel zlib-devel openssl-devel
```

--------------------------------

### Example configuration with /status/ API and zones

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_api/

Complete Angie configuration that sets up resolver, cache, limit_conn, limit_req, upstream, and server zones, and exposes the /status/ API with access restrictions. This configuration is used to demonstrate the metrics output.

```nginx
http {

    resolver 127.0.0.53 status_zone=resolver_zone;
    proxy_cache_path /var/cache/angie/cache keys_zone=cache_zone:2m;
    limit_conn_zone $binary_remote_addr zone=limit_conn_zone:10m;
    limit_req_zone $binary_remote_addr zone=limit_req_zone:10m rate=1r/s;

    upstream upstream {
        zone upstream 256k;
        server backend.example.com service=_example._tcp resolve max_conns=5;
       keepalive 4;
    }

    server {
        server_name www.example.com;
        listen 443 ssl;

        status_zone http_server_zone;
        proxy_cache cache_zone;
        proxy_cache_valid 200 10m;

        access_log /var/log/access.log main;

        location / {
            root /usr/share/angie/html;
            status_zone location_zone;
            limit_conn limit_conn_zone 1;
            limit_req zone=limit_req_zone burst=5;
        }
        location /status/ {
            api /status/;

            allow 127.0.0.1;
            deny all;
        }

    }
}
```

--------------------------------

### Start Angie and display process list

Source: https://en.angie.software/angie/docs/configuration/runtime/

Starts Angie and then displays the process list to show the master and worker processes. The output shows the master process with generation number #1.

```bash
$ sudo angie
$ ps aux | grep angie

    angie: master process v1.12.4 #1 [angie]
    angie: worker process #1
```

--------------------------------

### ngx.fetch() example: fetch and return response body

Source: https://en.angie.software/angie/docs/configuration/njs-reference/

Example of using ngx.fetch() to make a GET request to 'http://example.com/' and return the response body. The response is read using the text() method and returned with r.return().

```javascript
let reply = await ngx.fetch('http://example.com/');
let body = await reply.text();

r.return(200, body);
```

--------------------------------

### WASM module configuration example

Source: https://en.angie.software/angie/docs/configuration/modules/wasm/

Example configuration for the WASM module, loading core modules and a WASM module, defining a wasm_modules block, and using wasm_var and wasm_content directives.

```nginx
# These directives load the core functionality
load_module modules/ngx_wasm_module.so;
load_module modules/ngx_wasm_core_module.so;

load_module modules/ngx_wasmtime_module.so;

# Available here: https://git.angie.software/web-server/angie-wasm
load_module modules/ngx_http_wasm_host_module.so;

events {

}

wasm_modules {

    #use wasmtime;

    load ngx_http_handler.wasm id=handler;
    load ngx_http_vars.wasm id=vars type=reactor;
}

http {

    wasm_var vars "ngx:wasi/var-utils#sum-entry" $rvar $arg_a $arg_b $arg_c $arg_d;

    server {

        listen *:8080;

        location / {

            return 200 "sum('$arg_a','$arg_b','$arg_c','$arg_d')=$rvar\n";
        }

        location /wasm {

            client_max_body_size 20M;
            wasm_content handler "ngx:wasi/http-handler-entry#handle-request";
        }
    }
}
```

--------------------------------

### curl with pretty=off for compact JSON output

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_api/

Use the pretty=off query argument to get compact, single-line JSON output from the API. The example shows the curl command and its response.

```bash
$ curl https://www.example.com/status/connections?pretty=off

  {"accepted":2257,"dropped":0,"active":3,"idle":1}
```

--------------------------------

### Configuration example for limit_conn_zone and limit_conn

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_limit_conn/

Shows how to define a connection limit zone using $binary_remote_addr and apply a limit of 1 connection in the /download/ location.

```nginx
http {
    limit_conn_zone $binary_remote_addr zone=addr:10m;

    ...

    server {

        ...

        location /download/ {
            limit_conn addr 1;
        }
}
```

--------------------------------

### Install prerequisites for Angie repo (ALT)

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Updates package lists and installs curl and apt-https required for adding the Angie repository on ALT.

```bash
$ sudo apt-get update
$ sudo apt-get install -y curl apt-https
```

--------------------------------

### Basic charset configuration example

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_charset/

Shows a minimal configuration that includes a charset mapping file and sets the charset and source_charset directives.

```nginx
include        conf/koi-win;

charset        windows-1251;
source_charset koi8-r;
```

--------------------------------

### FreeBSD: Enable Angie autostart

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Enables Angie to start automatically after reboot.

```bash
$ sudo sysrc angie_enable=YES
```

--------------------------------

### limit_rate_after example: rate limit after 500k

Source: https://en.angie.software/angie/docs/configuration/modules/http/

Configures rate limiting to start after 500k of data have been transmitted, with a subsequent rate limit of 50k. Used in a location block for FLV streaming.

```nginx
location /flv/ {
 flv;
 limit_rate_after 500k;
 limit_rate       50k;
}
```

--------------------------------

### Core Module Configuration Example

Source: https://en.angie.software/angie/docs/configuration/modules/core/

Basic configuration showing user, worker_processes, error_log, and events block with kqueue and worker_connections.

```nginx
user www www;
worker_processes 2;

error_log /var/log/error.log info;

events {

    use kqueue; worker_connections 2048;
}
```

--------------------------------

### ssl_ciphers directive example

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_ssl/

Specifies enabled ciphers in OpenSSL format. The list depends on the installed OpenSSL version. With OpenSSL, TLS 1.3 ciphers are not configured by this directive; use ssl_conf_command Ciphersuites instead.

```nginx
ssl_ciphers ALL:!aNULL:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;
```

--------------------------------

### fastcgi_index example: set index.php and SCRIPT_FILENAME

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_fastcgi/

Shows how to set fastcgi_index and fastcgi_param SCRIPT_FILENAME so that requests ending with a slash get the index file appended. For /page.php, SCRIPT_FILENAME becomes /home/www/scripts/php/page.php; for /, it becomes /home/www/scripts/php/index.php.

```nginx
fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name;
```

--------------------------------

### FreeBSD: Create repo directories

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Creates the directories needed for the Angie pkg repo configuration.

```bash
$ sudo mkdir -p /usr/local/etc/pkg/angie/ /usr/local/etc/pkg/repos/
```

--------------------------------

### Example configuration template for templated images

Source: https://en.angie.software/angie/docs/installation/docker/

This is an example of the configuration template used by templated images. It shows how environment variables are applied, including conditional module loading and worker settings.

```nginx
...
{{- if has $modules "zstd"}}
# package: angie-module-zstd
load_module modules/ngx_http_zstd_filter_module.so;
load_module modules/ngx_http_zstd_static_module.so;
{{end}}

user  angie;
worker_processes  auto;
worker_rlimit_nofile {{.Env.ANGIE_WORKER_RLIMIT_NOFILE}};

error_log  /var/log/angie/error.log {{.Env.ANGIE_ERROR_LOG_SEVERITY}};
pid        {{.Env.ANGIE_PID_FILE}};

events {
    worker_connections  {{.Env.ANGIE_WORKER_CONNECTIONS}};
}

http {
    include       /etc/angie/mime.types;
    default_type  application/octet-stream;

    log_format  main  ...
```

--------------------------------

### curl with defaults=on to obtain default parameter values

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_api/

Use the defaults=on query argument (PRO) to get default parameter values for upstream server configuration. The example shows the curl command and the JSON response with default values.

```bash
$ curl http://127.0.0.1/config/http/upstreams/backend/servers?defaults=on
```

```json
{
    "backend.example.com": {
        "weight": 1,
        "max_conns": 5,
        "max_fails": 1,
        "fail_timeout": 10,
        "slow_start": 0,
        "backup": false,
        "down": false,
        "sid": ""
    }
}
```

--------------------------------

### curl with date=epoch for UNIX timestamp output

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_api/

Use the date=epoch query argument to get dates in integer UNIX epoch format instead of ISO 8601 strings. The example shows the default ISO 8601 output and the epoch output for the same endpoint.

```bash
$ curl https://www.example.com/status/angie/load_time

  "2024-03-31T23:59:59Z"
```

```bash
$ curl https://www.example.com/status/angie/load_time?date=epoch

  1711929599
```

--------------------------------

### FreeBSD: Configure Angie PRO repository

Source: https://en.angie.software/angie/docs/installation/pro_packages/

Creates the repository configuration file /usr/local/etc/pkg/repos/angie.conf with the specified contents.

```bash
angie: {
   url: "https://download.angie.software/angie-pro/freebsd/${VERSION_MAJOR}/${ARCH}",
   signature_type: "pubkey",
   pubkey: "/usr/local/etc/pkg/angie/angie-signing.rsa",
   enabled: yes
}
```

--------------------------------

### Manual Angie restart with core dump limit on FreeBSD

Source: https://en.angie.software/angie/docs/troubleshooting/

Commands to stop Angie manually, wait for the master process to exit, raise the core dump size limit, and start Angie in a single root shell. This is used when Angie is installed manually.

```bash
$ sudo <path to Angie installation directory>/sbin/angie -s quit
$ while [ -e <path to Angie installation directory>/logs/angie.pid ]; do sleep 1; done
$ sudo sh -c 'ulimit -c unlimited && exec <path to Angie installation directory>/sbin/angie'
```

--------------------------------

### Basic CGI configuration example

Source: https://en.angie.software/angie/docs/configuration/modules/external-modules/cgi/

Configures a server with a location /cgi that enables CGI with an alias to the cgi-bin directory.

```nginx
server {
    listen 80;

    root /usr/share/angie/html;
    index index.html index.htm;

    location /cgi {
        alias /usr/share/angie/cgi-bin;
        cgi on;
    }
}
```

--------------------------------

### Logging macros example: setting log->action and using ngx_log_error and ngx_log_debug2

Source: https://en.angie.software/angie/docs/developer_guide/

Shows how to set the current action and log error and debug messages. The error log includes the action and client info, while the debug log includes the mp4 start and length values.

```c
/* specify what is currently done */
log->action = "sending mp4 to client";

/* error and debug log */
ngx_log_error(NGX_LOG_INFO, c->log, 0, "client prematurely
              closed connection");

ngx_log_debug2(NGX_LOG_DEBUG_HTTP, mp4->file.log, 0,
               "mp4 start:%ui, length:%ui", mp4->start, mp4->length);
```

--------------------------------

### proxy_pass_request_headers example: disable request headers passing

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_proxy/

Shows a location block that disables passing both request headers and body to the proxied server using proxy_pass_request_headers off and proxy_pass_request_body off. Also sets proxy_method GET. Useful when the proxied server should not receive original request headers.

```nginx
location /x-accel-redirect-here/ {
    proxy_method GET;
    proxy_pass_request_headers off;
    proxy_pass_request_body off;

    proxy_pass ...;
}
```

--------------------------------

### proxy_pass_request_body example: disable request body passing

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_proxy/

Shows a location block that disables passing the request body to the proxied server using proxy_pass_request_body off. Also sets proxy_method GET and clears the Content-Length header. Used for scenarios like X-Accel-Redirect where the body is not needed.

```nginx
location /x-accel-redirect-here/ {
    proxy_method GET;
    proxy_pass_request_body off;
    proxy_set_header Content-Length "";

    proxy_pass ...;
}
```

--------------------------------

### FLV module configuration example

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_flv/

Enables FLV pseudo-streaming for .flv files in a location block.

```nginx
location ~ \.flv$ {
    flv;
}
```

--------------------------------

### VTS configuration example

Source: https://en.angie.software/angie/docs/configuration/modules/external-modules/vts/

Example http block configuration enabling vhost_traffic_status_zone and setting up a server with locations for /status.html and /status. The /status location uses vhost_traffic_status_display with html format.

```nginx
http {
    # ...
    vhost_traffic_status_zone;

    server {
        listen 80;
        server_name localhost;

        root  /usr/share/angie/html;
        index index.html index.htm;

        location = /status.html {
            root  /usr/share/angie-module-vts;
        }

        location /status {
            vhost_traffic_status_display;
            vhost_traffic_status_display_format html;
        }
    }
}
```

--------------------------------

### UnBrotli configuration example with backend

Source: https://en.angie.software/angie/docs/configuration/modules/external-modules/unbrotli/

Shows a server configuration that enables unbrotli for the /storage location and a backend server that serves .br files with the Content-Encoding: br header.

```nginx
server {
    listen 80 default_server;
    location / {
        root  /usr/share/angie/html;
        index index.html;
    }

    location /storage {
        unbrotli on;
        proxy_pass http://127.0.0.1:8080;
    }
}

# Backend
server {
    listen 8080;
    location /storage {
        root   /usr/share/angie;
        rewrite ^(.*)$ $1.br break;  # Return the compressed file with .br suffix
        add_header Content-Encoding br; # Indicate Brotli compression in the response header
    }
}
```

--------------------------------

### Example commit message

Source: https://en.angie.software/angie/docs/development/

Shows the recommended format for a commit message: a one-line summary (up to 67 characters) with optional prefix, followed by a blank line and detailed explanation. The summary starts with a capital letter and ends with a period; if a prefix is used, it is followed by a lowercase letter. Double whitespace separates sentences within a single line.

```text
API: bad things removed, good things added.

As explained elsewhere[1], the original API was bad because stuff;
this change was introduced to improve that aspect locally.

Levels of goodness have been implemented to mitigate the badness;
this is now the preferred way to work.  Also, the badness is gone.

[1] https://example.com
```

--------------------------------

### Configuration Example: log_format and access_log

Source: https://en.angie.software/angie/docs/configuration/modules/stream/stream_log/

Basic configuration showing a log format named 'basic' and an access_log directive using that format with a buffer of 32k.

```nginx
log_format basic '$remote_addr [$time_local] '
                 '$protocol $status $bytes_sent $bytes_received '
                 '$session_time';

access_log /spool/logs/angie-access.log basic buffer=32k;
```

--------------------------------

### Install angie-pro-headers on RHEL/Fedora

Source: https://en.angie.software/angie/docs/installation/external-modules/

Installs the angie-pro-headers package matching the installed angie-pro version on RHEL/Fedora and derivatives.

```bash
$ sudo dnf install "angie-pro-headers-$(rpm -q --qf '%{VERSION}-%{RELEASE}' angie-pro)"
```

--------------------------------

### Install Angie PRO package

Source: https://en.angie.software/angie/docs/installation/pro_packages/

Installs the angie-pro package using zypper with the -y flag to automatically confirm the installation.

```bash
$ sudo zypper install -y angie-pro
```

--------------------------------

### rewrite directive example: server context with last flag and return 403

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_rewrite/

Shows a server block with two rewrite directives using the 'last' flag to change URIs for /download/ paths, followed by a return 403. The 'last' flag stops processing the current set of rewrite directives and starts a search for a new location matching the changed URI.

```nginx
server {
#    ...
    rewrite ^(/download/.*)/media/(.*)\..*$ $1/mp3/$2.mp3 last;
    rewrite ^(/download/.*)/audio/(.*)\..*$ $1/mp3/$2.ra  last;
    return  403;
#    ...
}
```

--------------------------------

### Start Keepalived service

Source: https://en.angie.software/angie/docs/configuration/cluster/

Check the configuration and start the Keepalived service. The command runs keepalived with the -t flag to test the configuration, then starts the service.

```bash
$ sudo keepalived -t && sudo service keepalived start
```

--------------------------------

### Create angie.repo for AlmaLinux

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Repository configuration for AlmaLinux. Save as /etc/yum.repos.d/angie.repo.

```ini
[angie]
name=Angie repo
baseurl=https://download.en.angie.software/angie/almalinux/$releasever/
gpgcheck=1
enabled=1
gpgkey=https://angie.software/keys/angie-signing.gpg.asc
```

--------------------------------

### Install Angie on Alpine

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Install the Angie package on Alpine.

```bash
$ sudo apk add angie
```

--------------------------------

### Install angie-pro-headers on Debian/Ubuntu

Source: https://en.angie.software/angie/docs/installation/external-modules/

Installs the angie-pro-headers package matching the installed angie-pro version on Debian/Ubuntu. The package provides header files and build configuration for Angie PRO.

```bash
$ sudo apt install "angie-pro-headers=$(dpkg-query -W -f='${Version}' angie-pro)"
```

--------------------------------

### include directive example

Source: https://en.angie.software/angie/docs/configuration/modules/core/

Shows how to include other configuration files or masks. The included files must contain syntactically correct directives and blocks.

```nginx
include mime.types;
include vhosts/*.conf;
```

--------------------------------

### Configuration example for unzstd with backend

Source: https://en.angie.software/angie/docs/configuration/modules/external-modules/unzstd/

Shows a frontend server that enables `unzstd` for the `/storage` location and proxies to a backend that serves compressed `.zst` files with the `Content-Encoding: zstd` header.

```nginx
server {
    listen 80 default_server;
    location / {
        root  /usr/share/angie/html;
        index index.html;
    }

    location /storage {
        unzstd on;
        proxy_pass http://127.0.0.1:8080;
    }
}

# Backend
server {
    listen 8080;
    location /storage {
        root   /usr/share/angie;
        rewrite ^(.*)$ $1.zst break;  # Return the compressed file with .zst suffix
        add_header Content-Encoding zstd; # Indicate Zstandard compression in the response header
    }
}
```

--------------------------------

### Install angie-module-cgi

Source: https://en.angie.software/angie/docs/configuration/acme/

Installs the CGI module for Angie on Debian-based systems.

```bash
$ sudo apt-get install angie-module-cgi
```

--------------------------------

### Create angie.repo for Fedora

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Repository configuration for Fedora. Save as /etc/yum.repos.d/angie.repo.

```ini
[angie]
name=Angie repo
baseurl=https://download.en.angie.software/angie/fedora/$releasever/
gpgcheck=1
enabled=1
gpgkey=https://angie.software/keys/angie-signing.gpg.asc
```

--------------------------------

### Pool allocation example with ngx_palloc and ngx_pnalloc

Source: https://en.angie.software/angie/docs/developer_guide/

Shows how to create a pool and allocate memory from it using ngx_palloc and ngx_pnalloc. The example includes error checks for NULL returns and uses ngx_str_set and ngx_memcpy to initialize the allocated memory.

```c
u_char      *p;
ngx_str_t   *s;
ngx_pool_t  *pool;

pool = ngx_create_pool(1024, log);
if (pool == NULL) { /* error */ }

s = ngx_palloc(pool, sizeof(ngx_str_t));
if (s == NULL) { /* error */ }
ngx_str_set(s, "foo");

p = ngx_pnalloc(pool, 3);
if (p == NULL) { /* error */ }
ngx_memcpy(p, "foo", 3);
```

--------------------------------

### Build Angie from source with debug support

Source: https://en.angie.software/angie/docs/troubleshooting/

Commands to configure, build, and install Angie with the --with-debug option.

```bash
$ ./configure --with-debug ...
$ make
$ sudo make install
```

--------------------------------

### Install extra Angie packages (ALT)

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Installs additional Angie packages as needed.

```bash
$ sudo apt-get install -y <PACKAGE NAME>
```

--------------------------------

### Example response from /status/angie/ with config_files

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_api/

Shows the approximate JSON response when api_config_files is enabled, including the config_files object with file paths and contents.

```json
{
    "version":"1.12.4",
    "address":"192.168.16.5",
    "generation":1,
    "load_time":"2026-10-16T12:58:39.789Z",
    "config_files": {
        "/etc/angie/angie.conf": "...",
        "/etc/angie/mime.types": "..."
    }
}
```

--------------------------------

### Usage example for including prometheus_all.conf and exposing metrics

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_prometheus/

Shows how to include the Prometheus configuration file and expose metrics at a location. The location =/p8s uses the 'prometheus all' directive to serve all metrics.

```nginx
http {

    include prometheus_all.conf;

    # ...

    server {

        listen 80;

        location =/p8s {
            prometheus all;
        }

        # ...

    }
}
```

--------------------------------

### Install Angie via MacPorts

Source: https://en.angie.software/angie/docs/installation/thirdparty/

Installs the angie port using sudo. Use on macOS with MacPorts.

```bash
$ sudo port install angie
```

--------------------------------

### openSUSE: Configure Angie repo

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Contents for /etc/zypp/repos.d/angie.repo, configuring the Angie repository.

```ini
[angie]
name=Angie repo
baseurl=https://download.en.angie.software/angie/opensuse/$releasever_major/
gpgcheck=1
enabled=1
gpgkey=https://angie.software/keys/angie-signing.gpg.asc
```

--------------------------------

### Configure minimal build

Source: https://en.angie.software/angie/docs/installation/sourcebuild/

Runs the configure script with no options to prepare a minimal build, creating a Makefile.

```bash
$ ./configure
```

--------------------------------

### ALT: Install Angie PRO package

Source: https://en.angie.software/angie/docs/installation/pro_packages/

Installs the Angie PRO package using the apt package manager.

```bash
$ sudo apt-get install -y angie-pro
```

--------------------------------

### Alpine: Install Angie PRO package

Source: https://en.angie.software/angie/docs/installation/pro_packages/

Installs the Angie PRO package using the Alpine package manager.

```bash
$ sudo apk add angie-pro
```

--------------------------------

### Create angie.repo for RED OS

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Repository configuration for RED OS. Save as /etc/yum.repos.d/angie.repo.

```ini
[angie]
name=Angie repo
baseurl=https://download.en.angie.software/angie/redos/$releasever/
gpgcheck=1
enabled=1
gpgkey=https://angie.software/keys/angie-signing.gpg.asc
```

--------------------------------

### Configuration Example: Enable Basic Authentication

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_auth_basic/

Shows a basic location block that enables HTTP Basic Authentication with a realm string and specifies the user file. Use this to protect a location with a password.

```nginx
location / {
    auth_basic           "closed site";
    auth_basic_user_file conf/htpasswd;
}
```

--------------------------------

### Install Angie with yum or dnf

Source: https://en.angie.software/angie/docs/installation/oss_packages/

Install the Angie package on RPM-based distributions using either yum or dnf.

```bash
$ sudo yum install -y angie
$ # -- OR --
$ sudo dnf install -y angie
```

--------------------------------

### Install Angie via Homebrew

Source: https://en.angie.software/angie/docs/installation/thirdparty/

Adds the stychos/angie tap and installs the angie formula. Use on macOS with Homebrew.

```bash
$ brew tap stychos/angie
$ brew install stychos/angie/angie
```

--------------------------------

### Example configuration for serving pre-compressed files

Source: https://en.angie.software/angie/docs/configuration/modules/external-modules/brotli/

Enables static Brotli file serving with brotli_static on and specifies MIME types.

```nginx
server {
    listen 80 default_server;

    brotli_static on;
    brotli_types text/plain text/css;

    location / {
        root /usr/share/angie/html;
        index index.html;
    }
}
```

--------------------------------

### Install the acme-octodns hook script

Source: https://en.angie.software/angie/docs/configuration/acme/

Installs the CGI hook script into the CGI bin directory with executable permissions.

```bash
$ sudo install -m 755 acme-octodns /usr/share/angie/cgi-bin/
```

--------------------------------

### FastCGI configuration example

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_fastcgi/

Shows a basic location block that passes requests to a FastCGI server at localhost:9000, sets the index file, and defines FastCGI parameters.

```nginx
location / {
    fastcgi_pass  localhost:9000;
    fastcgi_index index.php;

    fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name;
    fastcgi_param QUERY_STRING    $query_string;
    fastcgi_param REQUEST_METHOD  $request_method;
    fastcgi_param CONTENT_TYPE    $content_type;
    fastcgi_param CONTENT_LENGTH  $content_length;
}
```

--------------------------------

### Stop nginx and start Angie

Source: https://en.angie.software/angie/docs/configuration/migration/

Use this command to minimize downtime by stopping nginx and starting Angie immediately after.

```bash
$ sudo systemctl stop nginx && sudo systemctl start angie
```

--------------------------------

### Enable AIO with directio on Linux

Source: https://en.angie.software/angie/docs/configuration/modules/http/

Configures AIO with directio for a /video/ location on Linux. Requires --with-file-aio and directio to avoid blocking reads.

```nginx
location /video/ {
  aio            on;
  directio       512;
  output_buffers 1 128k;
}
```

--------------------------------

### Configuration Example for stream_realip

Source: https://en.angie.software/angie/docs/configuration/modules/stream/stream_realip/

Example configuration enabling PROXY protocol on listen and setting trusted addresses with set_real_ip_from.

```nginx
listen 12345 proxy_protocol;

set_real_ip_from  192.168.1.0/24;
set_real_ip_from  192.168.2.1;
set_real_ip_from  2001:0db8::/32;
```

--------------------------------

### log_format proxy Example

Source: https://en.angie.software/angie/docs/configuration/modules/stream/stream_log/

Example of the log_format directive defining a format named 'proxy' that includes upstream-related variables.

```nginx
log_format proxy '$remote_addr [$time_local] '
                 '$protocol $status $bytes_sent $bytes_received '
                 '$session_time "$upstream_addr" '
                 '"$upstream_bytes_sent" "$upstream_bytes_received" "$upstream_connect_time"';
```

--------------------------------

### Sort and initialize dns_wc_head wildcard array

Source: https://en.angie.software/angie/docs/developer_guide/

Shows how to sort the dns_wc_head keys array and initialize the wildcard hash, storing the result in foo_hash.wc_head. The dns_wc_tail array is initialized similarly.

```c
if (foo_keys.dns_wc_head.nelts) {

    ngx_qsort(foo_keys.dns_wc_head.elts,
              (size_t) foo_keys.dns_wc_head.nelts,
              sizeof(ngx_hash_key_t),
              cmp_dns_wildcards);

    hash.hash = NULL;
    hash.temp_pool = pool;

    if (ngx_hash_wildcard_init(&hash, foo_keys.dns_wc_head.elts,
                               foo_keys.dns_wc_head.nelts)
        != NGX_OK)
    {
        return NGX_ERROR;
    }

    foo_hash.wc_head = (ngx_hash_wildcard_t *) hash.hash;
}
```

--------------------------------

### JSON output format example

Source: https://en.angie.software/angie/docs/configuration/modules/http/http_autoindex/

Example of the JSON directory listing output, with an array of objects containing file metadata.

```json
[
{
    "name": "example.txt",
    "type": "file",
    "size": 1234,
    "mtime": "2025-06-12T14:21:00Z"
},
{
    "name": "image.png",
    "type": "file",
    "size": 4321,
    "mtime": "2025-06-12T14:21:00Z"
}
]
```

--------------------------------

### Create test directories and files for static file serving

Source: https://en.angie.software/angie/docs/configuration/first-steps/

Creates two directories under /data and writes a small HTML file and a placeholder image file into them. The echo commands use 'sudo tee' to write the files, and the output shows the file contents.

```bash
$ sudo mkdir -p /data/www /data/images
$ echo 'Hello from /data/www' | sudo tee /data/www/index.html
Hello from /data/www
$ echo 'Hello from /data/images' | sudo tee /data/images/example.png
Hello from /data/images
```
Tokens:
Raw