The role implements the following:

* Creates a dedicated user/group for running the PHP scripts.

* Creates a base directory where the website-specific code and data should be

  stored at.

* Adds nginx to website's group, so nginx could read the necessary files.

  website, in format of ``web-ESCAPEDFQDN``, where ``ESCAPEDFQDN`` is equal to

  ``FQDN`` where dots have been replaced by underscores (for example,

  ``web-cloud_example_com``).

* All websites reside within a dedicated sub-directory in ``/var/www``. The

  sub-directory name is equal to the ``FQDN`` used for accessing the

  website. Owner of the directory is set to be the application administrator,

  **value** (string, mandatory)

    Configuration option.

**deny_files_regex** (list, optional, ``[]``)

  List of regular expressions for matching files/locations to which the web

    - role: php_website

      fqdn: cloud.example.com

      uid: 2001

      php_file_regex: \.php($|/)

      rewrites:

        - ^/\.well-known/host-meta /public.php?service=host-meta

        - comment: Use custom page for non-existing locations/files.

          value: error_page 404 /core/templates/404.php;

    - role: php_website

      deny_files_regex:

        - ^\..*

      php_rewrite_urls:

The role implements the following:

* Creates a dedicated user/group for running the WSGI application.

* Creates a base directory where the website-specific code and data should be

  stored at.

* Adds nginx to website's group, so nginx could read the necessary files.

  website, in format of ``web-ESCAPEDFQDN``, where ``ESCAPEDFQDN`` is equal to

  ``FQDN`` where dots have been replaced by underscores (for example,

  ``web-wiki_example_com``).

* All websites reside within a dedicated sub-directory in ``/var/www``. The

  sub-directory name is equal to the ``FQDN`` used for accessing the

  website. Owner of the directory is set to be the application administrator,

  directly, or copied to the directory in order to make sure the ``SGID`` gets

  honored. **Do not move the files, the permissions will not be set correctly.**

* Within the website directory, Python virtual environment can be found within

* Within the website directory, nginx will expect to find the static files

  within the ``htdocs`` sub-directory (this can be symlink too). Locations/aliases

  can be configured for static file serving.

  **value** (string, mandatory)

    Configuration option.

**enforce_https** (boolean, optional, ``True``)

  Specify if HTTPS should be enforced for the website or not. If enforced,

.. code-block:: yaml

    - role: wsgi_website

      fqdn: django.example.com

      static_locations:

        - /static

* The role is designed to execute every application via dedicated user and

  group. The user/group name is automatically derived from the FQDN of website,

  for example ``web-tbg_example_com``.

* PHP applications are executed via FastCGI, using the ``php5-fpm`` package.

* Static content (non-PHP) is served directly by *Nginx*.

* Each web application gets distinct sub-directory under ``/var/www``, named

  after the FQDN. All sub-directories created under there are created with

  ``2750`` permissions, with ownership set to admin user, and group set to the

         # Ok, so this role helps us set-up Nginx virtual host for serving our

         # app.

         - role: php_website

           # Our virtual host will for PHP website will respond to this name.

           fqdn: tbg.example.com

           # Some additional packages are required in order to deploy and use TBG.

                 dest="/var/www/tbg.example.com/thebuggenie-{{ tbg_version }}.tar.gz"

                 sha256sum=0fd0a680ba281adc97d5d2c720e63b995225c99716a36eca6a198b8a5ebf8057

        become: yes

      - name: Download Composer

        get_url: url=https://getcomposer.org/download/1.0.0-alpha10/composer.phar

                   dest="/var/www/tbg.example.com/" copy=no

                   creates="/var/www/tbg.example.com/thebuggenie-{{ tbg_version }}"

        become: yes

      - name: Create TBG cache directory

        file: path="/var/www/tbg.example.com/thebuggenie-{{ tbg_version }}/cache" state=directory mode=2770

        become: yes

      - name: Set-up the necessary write permissions for TBG directories

        file: path="{{ item }}" mode=g+w

        file: src="/var/www/tbg.example.com/thebuggenie-{{ tbg_version }}/public"

              path="/var/www/tbg.example.com/htdocs"

              state=link

        become: yes

      - name: Install TBG dependencies

        composer: command=install working_dir="/var/www/tbg.example.com/thebuggenie-{{ tbg_version }}"

        become: yes

      - name: Deploy database configuration file for TBG

        copy: src="b2db.yml" dest="/var/www/tbg.example.com/thebuggenie-{{ tbg_version }}/core/config/b2db.yml"

      - name: Deploy expect script for installing TBG

        copy: src="tbg_expect_install" dest="/var/www/tbg.example.com/tbg_expect_install" mode=750

        become: yes

      - name: Run TBG installer via expect script

        command: /var/www/tbg.example.com/tbg_expect_install

                 chdir=/var/www/tbg.example.com/thebuggenie-{{ tbg_version }} 

                 creates=/var/www/tbg.example.com/thebuggenie-{{ tbg_version }}/installed

        become: yes

5. Set-up the files that are deployed by our role.

* The role is designed to execute every application via dedicated user and

  group. The user/group name is automatically derived from the FQDN of website,

  for example ``web-wiki_example_com``.

* WSGI applications are executed via *Gunicorn*. The WSGI server listens on a

  Unix socket, making the socket accessible by *Nginx*.

* Static content is served directly by *Nginx*.

* Each web application gets distinct sub-directory under ``/var/www``, named

  after the FQDN. All sub-directories created under there are created with

  ``2750`` permissions, with ownership set to admin user, and group set to the

      dependencies:

         - role: wsgi_website

           fqdn: wiki.example.com

           # In many cases you need to have some development packages available

           # in order to build Python packages installed via pip

      - name: Create Django project directory

        file: dest="/var/www/wiki.example.com/code" state=directory

              mode=2750

      - name: Start Django project for the Wiki website

                 chdir=/var/www/wiki.example.com

                 creates=/var/www/wiki.example.com/code/wiki_example_com

        become: yes

      - name: Deploy settings for wiki website

        copy: src="{{ item }}" dest="/var/www/wiki.example.com/code/wiki_example_com/{{ item }}"

                       app_path="/var/www/wiki.example.com/code/"

                       virtualenv="/var/www/wiki.example.com/virtualenv/"

        become: yes

        with_items:

           - syncdb

           - migrate

      - name: Deploy the superadmin creation script

        copy: src="create_superadmin.py" dest="/var/www/wiki.example.com/code/create_superadmin.py"

      - name: Create initial superuser

        command: /var/www/wiki.example.com/virtualenv/bin/exec ./create_superadmin.py

                 chdir=/var/www/wiki.example.com/code/

        become: yes

        register: wiki_superuser

        changed_when: wiki_superuser.stdout == "Created superuser."

php_file_regex: \.php$

php_rewrite_urls: []

rewrites: []

https_tls_certificate: "{{ lookup('file', tls_certificate_dir + '/' + fqdn + '_https.pem') }}"

https_tls_key: "{{ lookup('file', tls_private_key_dir + '/' + fqdn + '_https.key') }}"

- name: Calculate username and home

  set_fact:

    user: "web-{{ fqdn | replace('.', '_') }}"

    home: "/var/www/{{ fqdn }}"

- name: Create PHP website group

  group: name="{{ user }}" gid="{{ uid | default(omit) }}" state=present

- name: Create home directory for the user (avoid populating with skeleton)

  file: path="{{ home }}" state=directory

        owner="{{ admin }}" group="{{ user }}" mode=2750

---

- set_fact:

    user: "web-{{ fqdn | replace('.', '_') }}"

    home: "/var/www/{{ fqdn }}"

- name: Create WSGI website group

  group: name="{{ user }}" gid="{{ uid | default(omit) }}" state=present

- name: Create home directory for the user (avoid populating with skeleton)

  file: path="{{ home }}" state=directory

        owner="{{ admin }}" group="{{ user }}" mode=2750

  template: src="venv_project.j2" dest="{{ home }}/virtualenv/.project"

            owner="{{ admin }}" group="{{ user }}" mode="640"

- name: Deploy virtualenv wrapper

  template: src="venv_exec.j2" dest="{{ home }}/virtualenv/bin/exec"

            owner="{{ admin }}" group="{{ user }}" mode="750"

- name: Install futures package for use with Gunicorn thread workers

  become_user: "{{ admin }}"

  pip: name=futures version="{{ futures_version }}" state=present virtualenv="{{ home }}/virtualenv"

dependencies:

  - role: php_website

    fqdn: phpinfo.{{ testsite_domain }}

    php_rewrite_urls:

      - ^(.*) /index.php

    uid: 2000

    enforce_https: False

    https_tls_key: "{{ lookup('file', inventory_dir + '/tls/phpinfo.' + testsite_domain + '_https.key') }}"

  - role: wsgi_website

    admin: admin

    fqdn: wsgi.{{ testsite_domain }}

    uid: 2001

    wsgi_application: wsgi:application

    static_locations: