.. _installation:

Installation
============

.. _requirements:

Requirements
------------

* **PHP**: Version 8.0 to 8.3
* **PostgreSQL**: Version 12 or greater
* **PHP Extensions**: ``PDO_PGSQL``, ``cURL``
* **HTTP Web Server**: Any, configured to work with PHP
* **Operating System**: A Unix-like system is recommended
* **Minimum Hardware Requirements**:
    * **PostgreSQL**: 512 MB RAM (2 GB recommended)
    * **Application**: 512 MB RAM (1 GB recommended)
    * **Storage**: Approximately 1 GB of PostgreSQL storage per 1 million events

If you prefer Apache web server, ``mod_rewrite`` and ``mod_headers`` should be enabled.

.. _instructions:

Instructions
------------

1. `Download <https://www.tirreno.com/download.php>`_ the latest version of :tirreno:`Tirreno` (a ZIP file).
2. Extract the tirreno-master.zip file to the location where you want it installed on your web server.
3. Navigate to ``http://your-domain.example/install/index.php`` in a browser to launch the installation process.
4. After the successful installation, delete the ``install/`` directory and its contents.
5. Navigate to ``http://your-domain.example/signup/`` in a browser to create an administrator account.
6. For cron jobs setup, insert the following schedule (every 10 minutes) expression with ``crontab -e`` command or by editing ``/var/spool/cron/your-web-server`` file:

.. code-block:: shell

    */10 * * * * cd /path/to/tirreno && /usr/bin/php /path/to/tirreno/index.php /cron >> /path/to/tirreno/logs/error.log 2>&1

.. _enrichment-subscription:

Enrichment Subscription
-----------------------

The optional :term:`Enrichment API` is available with the
:term:`Enterprise version` of :tirreno:`Tirreno`. This API provides
extended information on IP addresses, email addresses, domains, and
phone numbers. Enabling all data enrichment types transforms
:tirreno:`Tirreno` into a risk management and fraud prevention system.

To start with the :tirreno:`Tirreno` enrichment subscription:

1. Navigate to the `Tirreno pricing page
   <https://www.tirreno.com/pricing>`_.
2. Select the number of enrichment requests you need per month.
3. Proceed with the subscription by entering your email and country in
   the *Paddle* checkout.
4. Provide your credit card details and finalize the subscription payment.

After subscribing, you will receive an email from *team\@tirreno.com*
with the instructions and your :term:`enrichment key`. If you do not
receive the email, check your spam folder.

Follow these simple steps to activate your :term:`enrichment key`:

1. Log in to your :tirreno:`Tirreno` platform and go to the *API* page.
2. Copy the key from the email and paste it into the :term:`Enrichment
   key` input field.
3. Choose the type of data you would like to send for enrichment and
   click the ``Save`` button.

Voilà! Your :tirreno:`Tirreno` subscription is now fully active.