{"id":26916698,"url":"https://github.com/nginx/ansible-role-nginx-config","last_synced_at":"2025-04-09T05:09:31.167Z","repository":{"id":36990130,"uuid":"286496403","full_name":"nginx/ansible-role-nginx-config","owner":"nginx","description":"Ansible role for configuring NGINX","archived":false,"fork":false,"pushed_at":"2025-03-31T10:13:32.000Z","size":806,"stargazers_count":166,"open_issues_count":16,"forks_count":77,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-03-31T11:24:21.171Z","etag":null,"topics":["ansible","ansible-role","nginx","nginx-config"],"latest_commit_sha":null,"homepage":"https://galaxy.ansible.com/nginxinc/nginx_config","language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nginx.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":"SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-10T14:23:45.000Z","updated_at":"2025-03-31T10:13:34.000Z","dependencies_parsed_at":"2023-02-12T22:30:58.851Z","dependency_job_id":"f0d672e0-2ef4-4fba-9ef1-deabbf4cfff4","html_url":"https://github.com/nginx/ansible-role-nginx-config","commit_stats":null,"previous_names":["nginx/ansible-role-nginx-config"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginx%2Fansible-role-nginx-config","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginx%2Fansible-role-nginx-config/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginx%2Fansible-role-nginx-config/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginx%2Fansible-role-nginx-config/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nginx","download_url":"https://codeload.github.com/nginx/ansible-role-nginx-config/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247980837,"owners_count":21027808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ansible","ansible-role","nginx","nginx-config"],"created_at":"2025-04-01T19:36:35.864Z","updated_at":"2025-04-09T05:09:31.145Z","avatar_url":"https://github.com/nginx.png","language":"Jinja","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Ansible Galaxy](https://img.shields.io/badge/galaxy-nginxinc.nginx__config-5bbdbf.svg)](https://galaxy.ansible.com/nginxinc/nginx_config)\n[![Molecule CI/CD](https://github.com/nginx/ansible-role-nginx-config/actions/workflows/molecule.yml/badge.svg)](https://github.com/nginx/ansible-role-nginx-config/actions/workflows/molecule.yml)\n[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/nginx/ansible-role-nginx-config/badge)](https://securityscorecards.dev/viewer/?uri=github.com/nginx/ansible-role-nginx-config)\n[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)\n[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](/SUPPORT.md)\n[![Community Forum](https://img.shields.io/badge/community-forum-009639?logo=discourse\u0026link=https%3A%2F%2Fcommunity.nginx.org)](https://community.nginx.org)\n[![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](/CODE_OF_CONDUCT.md)\n\n# 👾 *Help make the NGINX config Ansible role better by participating in our [survey](https://forms.office.com/Pages/ResponsePage.aspx?id=L_093Ttq0UCb4L-DJ9gcUKLQ7uTJaE1PitM_37KR881UM0NCWkY5UlE5MUYyWU1aTUcxV0NRUllJSC4u)!* 👾\n\n# Ansible NGINX Configuration Role\n\nThis role configures NGINX Open Source and NGINX Plus on your target host.\n\n\u003e [!IMPORTANT]\n\u003e This role is still in active development. There may be unidentified issues and the role variables may change as development continues.\n\n## Role Requirements\n\n### Ansible\n\nIf you want to use this role, you will need to use a supported version of Ansible core and Jinja2 as well as a few Ansible collections.\n\nFor ease of use, you can install and/or upgrade Ansible core, Jinja2, and the aforementioned Ansible collections by running the following four commands on your Ansible host:\n\n```bash\npip install --upgrade -r https://raw.githubusercontent.com/nginx/ansible-role-nginx-config/main/.github/workflows/requirements/requirements_ansible.txt\ncurl -O https://raw.githubusercontent.com/nginx/ansible-role-nginx-config/main/.github/workflows/requirements/requirements_collections.yml\nansible-galaxy install --force -r requirements_collections.yml\nrm -f requirements_collections.yml\n```\n\nThis will also ensure you are deploying/running this role with a fully tested version of the aforementioned packages/collections.\n\n#### Ansible core\n\n- This role is developed and tested with [maintained](https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html) versions of Ansible core and Python.\n- When using Ansible core, you will also need to install the following Ansible collections:\n\n  ```yaml\n  ---\n  collections:\n    - name: ansible.posix\n      version: 2.0.0\n    - name: community.general\n      version: 10.5.0\n    - name: community.crypto # Only required if you plan to to test the NGINX Plus Molecule scenario\n      version: 2.26.0\n    - name: community.docker # Only required if you plan to use Molecule\n      version: 4.5.2\n  ```\n\n- Instructions on how to install Ansible core can be found in the [Ansible](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#upgrading-ansible-from-version-2-9-and-older-to-version-2-10-or-later) docs.\n- Instructions on how to install Ansible collections can be found in the [Ansible collections](https://docs.ansible.com/ansible/latest/collections_guide/collections_installing.html) guide.\n\n\u003e [!TIP]\n\u003e You can alternatively install the [Ansible community distribution](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#selecting-an-ansible-package-and-version-to-install) (what is still known Ansible -- instead of Ansible core) if you don't want to manage individual collections.\n\n### Jinja2\n\n- This role uses Jinja2 templates. Ansible core installs Jinja2 by default, but depending on your install and/or upgrade path, you might be running an outdated version of Jinja2. The minimum version of Jinja2 required for the role to properly function is `3.1`.\n- Instructions on how to install Jinja2 can be found in the [Jinja2 website](https://jinja.palletsprojects.com/en/3.1.x/intro/#installation).\n\n### Testing suite (Optional)\n\nIf you want to contribute to this role, you will also need to install Ansible Lint and Molecule.\n\n#### Ansible Lint (Optional)\n\n- Ansible Lint is used to lint the role for both Ansible best practices and potential Ansible/YAML issues.\n- Instructions on how to install Ansible Lint can be found in the [Ansible Lint website](https://ansible.readthedocs.io/projects/lint/installing/).\n- Once installed, using Ansible Lint is as easy as running:\n\n  ```bash\n  ansible-lint\n  ```\n\n- For ease of use, you can install and/or upgrade Ansible Lint by running the following command on your Ansible host:\n\n  ```bash\n  pip install -r https://raw.githubusercontent.com/nginx/ansible-role-nginx-config/main/.github/workflows/requirements/requirements_ansible_lint.txt\n  ```\n\n#### Molecule (Optional)\n\n- Molecule is used to test the various functionalities of the role.\n- Instructions on how to install Molecule can be found in the [Molecule website](https://molecule.readthedocs.io/en/latest/installation.html). *You will also need to install the Molecule plugins package and the Docker Python SDK.*\n- To run the NGINX Plus/App Protect config Molecule tests, you must copy your NGINX Plus/App Protect license to the role's Molecule [`common/files/license`](/molecule/common/files/license/) directory.\n\n  You can alternatively add your NGINX Plus/App Protect 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:\n\n  ```bash\n  export NGINX_CRT=$( cat \u003cpath to your certificate file\u003e | base64 )\n  export NGINX_KEY=$( cat \u003cpath to your key file\u003e | base64 )\n  molecule test -s plus\n  ```\n\n- For ease of use, you can install and/or upgrade Molecule, the Molecule plugins package, and the Docker Python SDK by running the following command on your Ansible host:\n\n  ```bash\n  pip install --upgrade -r https://raw.githubusercontent.com/nginx/ansible-role-nginx-config/main/.github/workflows/requirements/requirements_molecule.txt\n  ```\n\n## Role Installation\n\nThis role can be installed via either Ansible Galaxy (the Ansible community marketplace) or by cloning this repo. Once installed, you will need to include the role in your Ansible playbook using [the `roles` keyword, the `import_role` module, or the `include_role` module](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_reuse_roles.html#using-roles).\n\n### Ansible Galaxy\n\nTo install the latest stable release of the role on your system, use:\n\n```bash\nansible-galaxy install nginxinc.nginx_config\n```\n\nAlternatively, if you have already installed the role, you can update the role to the latest release by using:\n\n```bash\nansible-galaxy install -f nginxinc.nginx_config\n```\n\nTo use the role, include the following task in your playbook:\n\n```yaml\n- name: Configure NGINX\n  ansible.builtin.include_role:\n    name: nginxinc.nginx_config\n```\n\n### Git\n\nTo pull the latest edge commit of the role from GitHub, use:\n\n```bash\ngit clone https://github.com/nginx/ansible-role-nginx-config.git\n```\n\nTo use the role, include the following task in your playbook:\n\n```yaml\n- name: Configure NGINX\n  ansible.builtin.include_role:\n    name: \u003cpath/to/repo\u003e # e.g. \u003croles/ansible-role-nginx-config\u003e if you clone the repo inside your project's roles directory\n```\n\n## Platforms\n\nThe NGINX config Ansible role supports all platforms supported by [NGINX Open Source](https://nginx.org/en/linux_packages.html#mainline) and [NGINX Plus](https://www.nginx.com/products/technical-specs/).\n\n\u003e [!NOTE]\n\u003e You should be able to use this role to configure any NGINX installation -- wherever/however it's been installed -- at your own risk. Any potential bugs with the role involving unsupported installation methods/platforms will be addressed in a best effort manner and might be outright dismissed.*\n\n## Role Variables\n\nThis role has multiple variables. The descriptions and defaults for all these variables can be found in the **[`defaults/main/`](/defaults/main/)** directory in the following files:\n\n| Name | Description |\n| ---- | ----------- |\n| **[`main.yml`](/defaults/main/main.yml)** | NGINX simple config variables |\n| **[`selinux.yml`](/defaults/main/selinux.yml)** | Set up SELinux to allow the necessary connections to your NGINX setup |\n| **[`template.yml`](/defaults/main/template.yml)** | NGINX config template variables |\n| **[`upload.yml`](/defaults/main/upload.yml)** | NGINX config/HTML/SSL upload variables |\n\n## Example Playbooks\n\nWorking functional playbook examples can be found in the **[`molecule/`](/molecule/)** directory in the following files:\n\n| Name | Description |\n| ---- | ----------- |\n| **[`api/converge.yml`](/molecule/api/converge.yml)** | Configure the NGINX Plus API and live metrics dashboard |\n| **[`cleanup_config/converge.yml`](/molecule/cleanup_config/converge.yml)** | Cleanup an NGINX config |\n| **[`complete/converge.yml`](/molecule/complete/converge.yml)** | Test all NGINX directives are correctly templated |\n| **[`complete_plus/converge.yml`](/molecule/complete_plus/converge.yml)** | Test all NGINX Plus specific directives are correctly templated |\n| **[`default/converge.yml`](/molecule/default/converge.yml)** | Configure NGINX with a config as close as possible to the default config |\n| **[`push_config/converge.yml`](/molecule/push_config/converge.yml)** | Push a preexisting NGINX config from your system to your NGINX instance |\n| **[`reverse_proxy/converge.yml`](/molecule/reverse_proxy/converge.yml)** | Configure NGINX as a reverse proxy between two web servers |\n| **[`stub_status/converge.yml`](/molecule/stub_status/converge.yml)** | Configure the NGINX Open Source stub status metrics |\n| **[`web_server/converge.yml`](/molecule/web_server/converge.yml)** | Configure NGINX as a web server |\n\n\u003e [!NOTE]\n\u003e If you install this repository via Ansible Galaxy, you will need to replace the `include_role` variable in the example playbooks from `ansible-role-nginx-config` to `nginxinc.nginx_config`.\n\n## Other NGINX Ansible Collections and Roles\n\nYou can find the Ansible NGINX Core collection of roles to install and configure NGINX Open Source, NGINX Plus, and NGINX App Protect [here](https://github.com/nginxinc/ansible-collection-nginx).\n\nYou can find the Ansible NGINX role to install NGINX OSS and NGINX Plus [here](https://github.com/nginx/ansible-role-nginx).\n\nYou can find the Ansible NGINX App Protect role to install and configure NGINX App Protect WAF and NGINX App Protect DoS [here](https://github.com/nginxinc/ansible-role-nginx-app-protect).\n\nYou can find the Ansible NGINX Unit role to install NGINX Unit [here](https://github.com/nginxinc/ansible-role-nginx-unit).\n\n## License\n\n[Apache License, Version 2.0](/LICENSE)\n\n## Author Information\n\n[Alessandro Fael Garcia](https://github.com/alessfg)\n\n\u0026copy; [F5, Inc.](https://www.f5.com/) 2020 - 2025\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnginx%2Fansible-role-nginx-config","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnginx%2Fansible-role-nginx-config","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnginx%2Fansible-role-nginx-config/lists"}