computer-playbook/roles/nginx-www-redirect
Kevin Veen-Birkenbach 04b3ce18e0 Optimized nginx health-check and some regex 2023-12-12 17:43:13 +01:00
..
tasks Optimized nginx health-check and some regex 2023-12-12 17:43:13 +01:00
README.md Removed bugs and implemented new server config structure 2023-12-12 12:32:35 +01:00

README.md

README.md for nginx-www-redirect Role

Overview

The nginx-www-redirect role is designed to automate the process of setting up redirects from www.domain.tld to domain.tld for all domains and subdomains configured within the {{nginx_servers_directory}} directory. This role dynamically identifies configuration files following the pattern *domain.tld.conf and creates corresponding redirection rules.

Role Description

This role performs several key tasks:

  1. Find Configuration Files: Locates all .conf files in the {{nginx_servers_directory}} directory that match the *.*.conf pattern, ensuring that only domain and subdomain configurations are selected.

  2. Filter Domain Names: Processes each configuration file, extracting the domain names and removing both the .conf extension and the {{nginx_servers_directory}} path.

  3. Prepare Redirect Domain Mappings: Transforms the filtered domain names into a source-target mapping format, where source is www.domain.tld and target is domain.tld.

  4. Include nginx-domain-redirect Role: Applies the redirection configuration using the nginx-domain-redirect role with the dynamically generated domain mappings.

Usage

To use this role, include it in your playbook and ensure that the nginx-domain-redirect role is available in your Ansible environment. No additional configuration is required as the role is designed to dynamically identify and process the domain configurations.

Example playbook:

- hosts: web-servers
  roles:
    - nginx-www-redirect

Requirements

  • Ansible environment set up and configured to run roles.
  • Access to the {{nginx_servers_directory}} directory on the target hosts.
  • The nginx-domain-redirect role must be present and properly configured to handle the redirection mappings.

Notes

  • This role is designed to work in environments where domain and subdomain configurations follow the naming pattern *domain.tld.conf.
  • It automatically excludes any configurations that begin with www., preventing duplicate redirects.

This nginx-www-redirect role was crafted with insights and guidance provided by ChatGPT, an advanced AI language model from OpenAI. The development process, including the discussions with ChatGPT that shaped this role, can be here explored in detail.