Build a custom agent
If your Linux distribution or preferred NGINX version is not in the supported matrix, or if you require additional custom flags in your NGINX build that break compatibility with the tCell module, we recommend that you compile your own module.
To build your own version of the tCell module:
- Ensure your build environment is up-to-date.
- Download the NGINX source code.
- Download the module source.
- Install the required packages to build your version of NGINX.
- Build and install NGINX.
- Update your NGINX configuration and provide the agent configuration.
- Start the NGINX service.
Ensure your build environment is up-to-date
The module contains static libraries which are linked depending on the distribution's version of
libc. If your version of
binutils is out-of-date, the module will fail to compile.
If building with
Glibc, use the following versions:
If building with
musl libc, use the following versions:
ldd -v to check the
ld -v to check the
Download the NGINX source code
Support: We support custom module compilation only for versions of NGINX after 1.10.3.
Download the module source
The most recent source code for the tCell NGINX module is available for installation on the tCell dashboard, under the
Download Agent tab in the Admin menu. Move the decompressed source into your NGINX source directory.
Support: We provide the module source only for versions of the agent after 3.2.2.
Install the required packages to build your version of NGINX
The tCell NGINX module requires the
libuuid development library to be built. By default, NGINX requires the
libzip development libraries to be built as well. Use the appropriate package manager to install these packages:
1sudo apt update && sudo apt install uuid-dev libssl-dev libpcre3-dev libzip-dev
1sudo apk update && sudo apk add libuuid libssl-devel libpcre3-devel libzip-devel
Build and install NGINX
configure script in the NGINX source directory with your desired flags, adding one of these lines to the end of every configuration argument:
A more in-depth guide to the NGINX build process and flags can be found on the official NGINX site.
Note: Report any issues with configuration or building to tCell Support.
Update your NGINX configuration and provide the agent configuration
During the configuration step, the
--prefix parameter specifies the path to the NGINX configuration directory; the default is
--conf-path parameter specifies the name of the NGINX configuration directory; the default is
conf. The NGINX configuration file is named
- Add the following line to
1load_module modules/ngx_http_tcell_agent_module so;
- Ensure that the
tcell_app_idis set inside the
- Copy the
tcell_agent.conffile from the dashboard into the
Start the NGINX service
1sudo nginx -s quit2sudo nginx
You should now be running an NGINX service protected by tCell. Check your tCell log directory to make sure everything started correctly.