Building Angie from Source#

We recommend installing Angie from packages. However, if you still need your own build:

  1. Download the .tar.gz archive from our website:

    $ curl -O https://download.angie.software/files/angie-1.5.2.tar.gz
    
  2. Unpack the sources and enter the code directory:

    $ tar -xpf angie-1.5.2.tar.gz
    $ cd angie-1.5.2
    
  3. To prepare the build, use the configure script to determine the specific traits of the OS where the build occurs, in particular, the methods that Angie can use to handle connections. After a successful run, the script creates a Makefile.

    Before running configure, browse the options to choose the optimal layout:

    $ ./configure <OPTIONS>
    
  4. When Makefile is ready, build and install Angie:

    $ make
    $ make install
    

Build Options#

General#

Parameter

Default

--help
prints a help message.

--user=name
sets the name of an unprivileged user whose credentials will be used by worker processes. After installation, the name can always be changed in the angie.conf configuration file using the user directive.

nobody

--group=name
sets the name of a group whose credentials will be used by worker processes. After installation, the name can always be changed in the angie.conf configuration file using the user directive.

is set to the name of an unprivileged user

--build=name
sets an optional Angie build name.

--builddir=path
sets a build directory.

objs

Paths#

Parameter

Default

--prefix=path
defines a directory that will keep server files. This same directory will also be used for all relative paths set by configure (except for paths to libraries sources) and in the angie.conf configuration file.

/usr/local/angie

--sbin-path=path
sets the name of an Angie executable file. This name is used only during installation.

<prefix>/sbin/angie

--modules-path=path
defines a directory where Angie dynamic modules will be installed.

<prefix>/modules

--conf-path=path
sets the name of an angie.conf configuration file. If needs be, Angie can always be started with a different configuration file, by specifying it in the command-line parameter -c file.

<prefix>/conf/angie.conf

--error-log-path=path
sets the name of the primary error, warnings, and diagnostic file. After installation, the file name can always be changed in the angie.conf configuration file using the error_log directive.

<prefix>/logs/error.log

--pid-path=path
sets the name of an angie.pid file that will store the process ID of the main process. After installation, the file name can always be changed in the angie.conf configuration file using the pid directive.

<prefix>/logs/angie.pid

--lock-path=path
sets a prefix for the names of lock files. After installation, the value can always be changed in the angie.conf configuration file using the lock_file directive.

<prefix>/logs/angie.lock

--http-acme-client-path=path
sets the directory to store certificates and keys obtained for server blocks that have acme directives defined.

<prefix>/acme_client

--http-log-path=path
sets the name of the primary request log file of the HTTP server. After installation, the file name can always be changed in the angie.conf configuration file using the access_log directive.

<prefix>/logs/access.log

--http-client-body-temp-path=path
defines a directory for storing temporary files that hold client request bodies. After installation, the directory can always be changed in the angie.conf configuration file using the client_body_temp_path directive.

<prefix>/client_body_temp

--http-proxy-temp-path=path
defines a directory for storing temporary files with data received from proxied servers. After installation, the directory can always be changed in the angie.conf configuration file using the proxy_temp_path directive.

<prefix>/proxy_temp

--http-fastcgi-temp-path=path
defines a directory for storing temporary files with data received from FastCGI servers. After installation, the directory can always be changed in the angie.conf configuration file using the fastcgi_temp_path directive.

<prefix>/fastcgi_temp

--http-uwsgi-temp-path=path
defines a directory for storing temporary files with data received from uwsgi servers. After installation, the directory can always be changed in the angie.conf configuration file using the uwsgi_temp_path directive.

<prefix>/uwsgi_temp

--http-scgi-temp-path=path
defines a directory for storing temporary files with data received from SCGI servers. After installation, the directory can always be changed in the angie.conf configuration file using the scgi_temp_path directive.

<prefix>/scgi_temp

Features and dependencies#

--with-select_module / --without-select_module
enables or disables building a module that allows the server to work with the select() method. This module is built automatically if the platform does not appear to support more appropriate methods such as kqueue, epoll, or /dev/poll.

--with-poll_module / --without-poll_module
enables or disables building a module that allows the server to run using poll(). The module is built automatically if the platform doesn’t support more suitable methods such as kqueue, epoll, or /dev/poll.

--with-threads
enables the use of thread pools.

--with-file-aio
enables the use of asynchronous file I/O (AIO) on FreeBSD and Linux.

--with-debug
enables the debugging log.

--without-http-cache
disables HTTP cache.

--with-pcre
fsets the path to the sources of the PCRE library. The library distribution needs to be downloaded from the PCRE site and extracted. The rest is done by angie’s ./configure and make. The library is required for regular expressions support in the location directive and for the http_rewrite module.
--with-pcre-opt=parameters
sets additional build options for PCRE.
--with-pcre-jit
builds the PCRE library with “just-in-time compilation” support (the pcre_jit directive).

--without-pcre
disables the usage of the PCRE library.

--without-pcre2
disables use of the PCRE2 library instead of the original PCRE library.

--with-libatomic
forces the libatomic_ops library usage.
--with-libatomic=path
sets the path to the libatomic_ops library sources.

--with-openssl=path
enables and sets the path to the OpenSSL library sources.
--with-openssl-opt=parameters
sets additional build options for OpenSSL.

--with-ntls
enables server-side and client-side NTLS support in the HTTP and stream (server-side, client_side when linked with NTLS-enabled SSL library.

--with-zlib=path
sets the path to the sources of the zlib library. The library distribution (version 1.1.3 — 1.2.11) needs to be downloaded from the zlib site and extracted. The rest is done by Angie’s ./configure and make. The library is required for the http_gzip module.
--with-zlib-opt=parameters
sets additional build options for zlib.
--with-zlib-asm=cpu
enables the use of the zlib assembler sources optimized for one of the specified CPUs: pentium, pentiumpro.

Angie Modules#

http#

Enabling additional modules#

--with-http_acme_module
enables building the http_acme module that enables the ACME protocol.

--with-http_addition_module
enables building the http_addition module that adds text before and after a response.

--with-http_auth_request_module
enables building the http_auth_request module that implements client authorization based on the result of a subrequest.

--with-http_dav_module
enables building the http_dav module that provides file management automation via the WebDAV protocol.

--with-http_degradation_module
enables building the http_degradation module.

--with-http_flv_module
enables building the http_flv module that provides pseudo-streaming server-side support for Flash Video (FLV) files.

--with-http_geoip_module / --with-http_geoip_module=dynamic
enables building the http_geoip module that creates variables depending on the client IP address and the precompiled MaxMind databases.

--with-http_gunzip_module
enables building the http_gunzip module that decompresses responses with “Content-Encoding: gzip” for clients that do not support gzip encoding method.

--with-http_gzip_static_module
enables building the http_gzip_static module that enables sending precompressed files with the “.gz” filename extension instead of regular files.

--with-http_image_filter_module / --with-http_image_filter_module=dynamic
enables building the http_image_filter module that transforms images in JPEG, GIF, PNG, and WebP formats.

--with-http_mp4_module
enables building the http_mp4 module that provides pseudo-streaming server-side support for MP4 files.

--with-http_perl_module / --with-http_perl_module=dynamic
enables building the embedded Perl module.
--with-perl_modules_path=path
defines a directory that will keep Perl modules.
--with-perl=path
sets the name of the Perl binary.

--with-http_random_index_module
enables building the http_random_index module that processes requests ending with the slash character (/) and picks a random file in a directory to serve as an index file.

--with-http_realip_module
enables building the http_realip module that changes the client address to the address sent in the specified header field.

--with-http_secure_link_module
enables building the http_secure_link module.

--with-http_slice_module
enables building the http_slice module that splits a request into subrequests, each returning a certain range of response. The module provides more effective caching of big responses.

--with-http_ssl_module
enables building a module that adds the HTTPS protocol support to an HTTP server.
The OpenSSL library is required to build and run this module.

--with-http_stub_status_module
enables building the http_stub_status module that provides access to basic status information.

--with-http_sub_module
enables building the http_sub module that modifies a response by replacing one specified string by another.

--with-http_v2_module
enables building a module that provides support for HTTP/2.

--with-http_v3_module
enables building a module that provides support for HTTP/3.
An SSL library that provides HTTP/3 support is recommended to build and run this module, such as BoringSSL, LibreSSL, or QuicTLS. Otherwise, if using the OpenSSL library, OpenSSL compatibility layer will be used that does not support QUIC early data.

--with-http_xslt_module / --with-http_xslt_module=dynamic
enables building the http_xslt module that transforms XML responses using one or more XSLT stylesheets. The libxml2 and libxslt libraries are required to build and run this module.

--with-google_perftools_module
enables building the google_perftools module that enables profiling of Angie worker processes using Google Performance Tools. The module is intended for Angie developers.

Disable standard modules#

--without-http
disables the HTTP server.

--without-http_access_module
disables building the http_access module that allows limiting access to certain client addresses.

--without-http_api_module
disables building a module API, providing HTTP RESTful interface for accessing in JSON format information about a web server instance.

--without-http_auth_basic_module
disables building the http_auth_basic module that allows limiting access to resources by validating the user name and password using the “HTTP Basic Authentication” protocol.

--without-http_autoindex_module
disables building the http_autoindex module that processes requests ending with the slash character (/) and produces a directory listing in case the http_index module cannot find an index file.

--without-http_browser_module
disables building the http_browser module that creates variables whose values depend on the value of the “User-Agent” request header field.

--without-http_charset_module
disables building the http_charset module that adds the specified charset to the “Content-Type” response header field and can additionally convert data from one charset to another.

--without-http_empty_gif_module
disables building a module that emits single-pixel transparent GIF.

--without-http_fastcgi_module
disables building the http_fastcgi module that passes requests to a FastCGI server.

--without-http_geo_module
disables building the http_geo module that creates variables with values depending on the client IP address.

--without-http_gzip_module
disables building a module that compresses responses of an HTTP server. The zlib library is required to build and run this module.

--without-http_grpc_module
disables building the http_grpc module that passes requests to a gRPC server.

--without-http_limit_conn_module
disables building the http_limit_conn module that limits the number of connections per key, for example, the number of connections from a single IP address.

--without-http_limit_req_module
disables building the http_limit_req module that limits the request processing rate per key, for example, the processing rate of requests coming from a single IP address.

--without-http_map_module
disables building the http_map module that creates variables with values depending on values of other variables.

--without-http_memcached_module
disables building the http_memcached module that obtains responses from a memcached server.

--without-http_mirror_module
disables building the http_mirror module that implements mirroring of an original request by creating background mirror subrequests.

--without-http_proxy_module
disables building an HTTP server proxying module.

--without-http_prometheus_module
disables building the Prometheus module for the HTTP server.

--without-http_referer_module
disables building the http_referer module that can block access to a site for requests with invalid values in the “Referer” header field.

--without-http_rewrite_module
disables building a module that allows an HTTP server to redirect requests and change URI of requests. The PCRE library is required to build and run this module.

--without-http_scgi_module
disables building the http_scgi module that passes requests to an SCGI server.

--without-http_split_clients_module
disables building the http_split_clients module that creates variables for A/B testing.

--without-http_ssi_module
disables building the http_ssi module that processes SSI (Server Side Includes) commands in responses passing through it.

--without-http_upstream_hash_module
disables building a module that implements the hash load balancing method.

--without-http_upstream_ip_hash_module
disables building a module that implements the ip_hash load balancing method.

--without-http_upstream_keepalive_module
disables building a module that provides caching of connections to upstream servers.

--without-http_upstream_least_conn_module
disables building a module that implements the least_conn load balancing method.

--without-http_upstream_random_module
disables building a module that implements the random load balancing method.

--without-http_upstream_sticky_module
disables building a module that implements session persistence functionality, ensuring all requests in the client session are passed to the same backend server in upstream group.

--without-http_upstream_zone_module
disables building a module that makes it possible to store run-time state of an upstream group in a shared memory zone.

--without-http_userid_module
disables building the http_userid module that sets cookies suitable for client identification.

--without-http_uwsgi_module
disables building the http_uwsgi module that passes requests to a uwsgi server.

stream#

Enable additional modules#

--with-stream / --with-stream=dynamic
enables building the stream_core module for generic TCP/UDP proxying and load balancing.

--with-stream_geoip_module / --with-stream_geoip_module=dynamic
enables building the stream_geoip module that creates variables depending on the client IP address and the precompiled MaxMind databases.

--with-stream_realip_module
enables building the stream_realip module that changes the client address to the address sent in the PROXY protocol header.

--with-stream_ssl_module
enables building a module that adds the SSL/TLS protocol support to the stream module. The OpenSSL library is required to build and run this module.

--with-stream_ssl_preread_module
enables building the stream_ssl_preread module that allows extracting information from the ClientHello message without terminating SSL/TLS.

--with-stream_mqtt_preread_module
enables building the stream_mqtt_preread module that allows extracting client IDs and usernames from CONNECT packets in MQTT versions 3.1.1 and 5.0.

Disable standard modules#

--without-stream_access_module
disables building the stream_access module that allows limiting access to certain client addresses.

--without-stream_geo_module
disables building the stream_geo module that creates variables with values depending on the client IP address.

--without-stream_limit_conn_module
disables building the stream_limit_conn module that limits the number of connections per key, for example, the number of connections from a single IP address.

--without-stream_map_module
disables building the stream_map module that creates variables with values depending on values of other variables.

--without-stream_return_module
disables building the stream_return module that sends some specified value to the client and then closes the connection.

--without-stream_set_module
disables building the stream_set module that sets a value for a variable.

--without-stream_split_clients_module
disables building the stream_split_clients module that creates variables for A/B testing.

--without-stream_upstream_hash_module
disables building a module that implements the hash load balancing method.

--without-stream_upstream_least_conn_module
disables building a module that implements the least_conn load balancing method.

--without-stream_upstream_random_module
disables building a module that implements the random load balancing method.

--without-stream_upstream_zone_module
disables building a module that makes it possible to store run-time state of an upstream group in a shared memory zone.

mail#

Enable additional modules#

--with-mail / --with-mail=dynamic
enables POP3/IMAP4/SMTP mail proxy server.

--with-mail_ssl_module
enables building a module that adds the SSL/TLS protocol support to the mail proxy server. The OpenSSL library is required to build and run this module.

Disable standard modules#

--without-mail_imap_module
disables the IMAP protocol in mail proxy server.

--without-mail_pop3_module
disables the POP3 protocol in mail proxy server.

--without-mail_smtp_module
disables the SMTP protocol in mail proxy server.

Build options#

--with-cpp_test_module
enables building the ngx_cpp_test_module.

--add-module=path
enables an external module.

--add-dynamic-module=path
enables an external dynamic module.

--with-compat
enables dynamic modules compatibility.

--with-cc=path
sets the name of the C compiler.

--with-cpp=path
sets the name of the C preprocessor.

--with-cc-opt=parameters
sets additional parameters that will be added to the CFLAGS variable. When using the system PCRE library under FreeBSD, ‑‑with‑cc‑opt="‑I /usr/local/include" should be specified. If the number of files supported by select() needs to be increased it can also be specified here such as this: ‑‑with‑cc‑opt="‑D FD_SETSIZE=2048".

--with-ld-opt=parameters
sets additional parameters that will be used during linking. When using the system PCRE library under FreeBSD, ‑‑with‑ld‑opt="‑L /usr/local/lib" should be specified.

--with-cpu-opt=cpu
enables building per specified CPU: pentium, pentiumpro, pentium3, pentium4, athlon, opteron, sparc32, sparc64, ppc64.

Example of parameters usage#

./configure \
     --sbin-path=/usr/sbin/angie/ \
     --conf-path=/etc/angie/angie.conf \
     --pid-path=/run/angie.pid \
     --with-http_ssl_module \
     --with-pcre=../pcre2-10.40 \
     --with-zlib=../zlib-1.3