This role installs NGINX Open Source, NGINX Plus, or the NGINX Amplify agent on your target host.
Note: This role is still in active development. There may be unidentified issues and the role variables may change as development continues.
If you wish to install NGINX Plus using this role, you will need to obtain an NGINX Plus license beforehand. You do not need to do anything beforehand if you want to install NGINX OSS.
This role is developed and tested with maintained versions of Ansible core (above
When using Ansible core, you will also need to install the following collections:
--- collections: - name: ansible.posix version: 1.4.0 - name: community.general version: 6.2.0 - name: community.crypto # Only required if you plan to install NGINX Plus version: 2.10.0 - name: community.docker # Only required if you plan to use Molecule (see below) version: 3.4.0
Note: You can alternatively install the Ansible community distribution (what is known as the "old" Ansible) if you don't want to manage individual collections.
You will need to run this role as a root user using Ansible's
become parameter. Make sure you have set up the appropriate permissions on your target hosts.
Instructions on how to install Ansible can be found in the Ansible website.
You can alternatively add your NGINX Plus repository certificate and key to the local environment. Run the following commands to export these files as base64-encoded variables and execute the Molecule tests:
export NGINX_CRT=$( cat <path to your certificate file> | base64 ) export NGINX_KEY=$( cat <path to your key file> | base64 ) molecule test -s plus
ansible-galaxy install nginxinc.nginx to install the latest stable release of the role on your system. Alternatively, if you have already installed the role, use
ansible-galaxy install -f nginxinc.nginx to update the role to the latest release.
git clone https://github.com/nginxinc/ansible-role-nginx.git to pull the latest edge commit of the role from GitHub.
AlmaLinux: - 8 - 9 Alpine: - 3.14 - 3.15 - 3.16 - 3.17 Amazon Linux: - 2 CentOS: - 7.4+ Debian: - bullseye (11) Oracle Linux: - 7 - 8 - 9 Red Hat: - 7.4+ - 8 - 9 Rocky Linux: - 8 - 9 SUSE/SLES: - 12 - 15 Ubuntu: - bionic (18.04) - focal (20.04) - impish (21.10) - jammy (22.04)
AlmaLinux: - 8 - 9 Alpine: - 3.13 - 3.14 - 3.15 - 3.16 - 3.17 Amazon Linux 2: - any CentOS: - 7.4+ Debian: - bullseye (11) FreeBSD: - 12.1+ - 13 Oracle Linux: - 7.4+ Red Hat: - 7.4+ - 8 - 9 Rocky Linux: - 8 - 9 SUSE/SLES: - 12 - 15 Ubuntu: - bionic (18.04) - focal (20.04) - jammy (22.04)
Amazon Linux 2: - any Debian: - buster (10) - bullseye (11) Red Hat: - 8 Ubuntu: - bionic - focal
Note: You can also use this role to compile NGINX Open Source from source, install NGINX Open Source on compatible yet unsupported platforms, or install NGINX Open Source on BSD systems at your own risk.
This role has multiple variables. The descriptions and defaults for all these variables can be found in the
defaults/main/ folder in the following files:
||NGINX installation variables|
||NGINX Amplify agent installation variables|
||BSD installation variables|
||Logrotate configuration variables|
||SELinux configuration variables|
||Systemd configuration variables|
Similarly, descriptions and defaults for preset variables can be found in the
vars/ folder in the following files:
||List of supported NGINX platforms, modules, and Linux installation variables|
Working functional playbook examples can be found in the
molecule/ folder in the following files:
||Install a specific version of NGINX and set up logrotate|
||Downgrade to a specific version of NGINX|
||Downgrade to a specific version of NGINX Plus|
||Install various NGINX supported modules|
||Install NGINX Plus and various NGINX Plus supported modules|
||Install NGINX from source|
||Uninstall NGINX Plus|
||Upgrade NGINX Plus|
Do note that if you install this repository via Ansible Galaxy, you will have to replace the role variable in the sample playbooks from
You can find the Ansible NGINX Core collection of roles to install and configure NGINX Open Source, NGINX Plus, and NGINX App Protect here.
You can find the Ansible NGINX configuration role to configure NGINX here.
You can find the Ansible NGINX App Protect role to install and configure NGINX App Protect WAF and NGINX App Protect DoS here.
You can find the Ansible NGINX Unit role to install NGINX Unit here.
© F5, Inc. 2018 - 2023