#######################################################################################################

:exclamation: DEPRECATION :exclamation:

This repository and the role associated are deprecated in favor of the Manala Ansible Collection

You will find informations on its usage on the collection repository

#######################################################################################################

Ansible Role: Nginx

:exclamation: Report issues and send Pull Requests in the main Ansible Role repository :exclamation:

This role will deal with the setup and config of Nginx.

It's part of the Manala Ansible stack but can be used as a stand alone component.

Requirements

This role is made to work with the official nginx debian packages, available on the nginx debian repository. Please use the manala.apt role to handle it properly.

manala_apt_preferences:
  - nginx@nginx

Dependencies

None.

Installation

Ansible 2+

Using ansible galaxy cli:

ansible-galaxy install manala.nginx

Using ansible galaxy requirements file:

- src: manala.nginx

Role Handlers

Role Variables

Nginx configuration

The manala_nginx_config_template key will allow you to use main configuration templates. The role is shipped with default upstream template:

manala_nginx_config_template: config/nginx/nginx.conf.j2

But you can feel free to use your owns:

manala_nginx_config_template: my/nginx.conf.j2

The manala_nginx_config key is made to allow you to alter main Nginx configuration template.

Examples:

Use raw content:

manala_nginx_config: |
  user nginx;
  worker_processes 1;

Use dict's array (deprecated):

manala_nginx_config:
  - user: nginx
  - load_module: modules/ngx_http_geoip_module.so
  - load_module: modules/ngx_stream_geoip_module.so
  - events:
    - worker_connections: 1024

Exclusivity

manala_nginx_configs_exclusive allow you to clean up existing nginx configuration files into directory defined by the manala_nginx_configs_dir key. Made to be sure no old or manually created files will alter current configuration.

manala_nginx_configs_exclusive: true

Configurations

The manala_nginx_configs key is made to define Nginx configurations.

A state (present|absent|ignore) can be provided.

manala_nginx_configs:
  # Template based
  - file: template.conf
    template: my/template.conf.j2
  # Raw content based
  - file: content.conf
    config: |
      server {
          listen 80 default_server;
          listen [::]:80 default_server;
          server_name example.com www.example.com;
          root /var/www/example.com;
          index index.html;
          try_files $uri /index.html;
      }
  # Dict's array based (deprecated)
  - file: symfony2.conf
    config:
      - server:
        - server_name: symfony2.dev
        - root: /srv/symfony2/web
        - access_log: /var/log/nginx/app.access.log
        - error_log: /var/log/nginx/app.error.log
        - client_max_body_size: 8G
        - include: conf.d/gzip
        - location ^~ /sf/:
          - alias: /usr/share/symfony/symfony-1.4/data/web/sf/
        - location /:
          - try_files: $uri /index.php$is_args$args
        - location ~ ^/(index|frontend_dev)\.php(/|$):
          - include: conf.d/php_fpm_params
  # Ensure config is absent
  - file: absent.conf
    state: absent # "present" by default
  # Ignore config
  - file: ignore.conf
    state: ignore
  # Flatten configs
  - "{{ my_custom_configs_array }}"

Example playbook

- hosts: servers
  roles:
    - role: manala.nginx

Licence

MIT

Author information

Manala (http://www.manala.io/)