From cc67aa91d961476cf8ef0b256b8afabf7853ec50 Mon Sep 17 00:00:00 2001 From: YugaEgo Date: Thu, 26 Dec 2024 20:35:36 +0200 Subject: [PATCH] Adjust README --- README.md | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 065473e..8d87459 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,16 @@

-Tirreno is an open-source user analytics. +Tirreno is open-source user analytics software. -Tirreno is a universal analytic tool for the monitoring of online platforms, web applications, SaaS, communities, IoT, mobile applications, intranets and e-commerce websites. It is effective against external threats associated with partners or customers, as well as internal risks posed by employees or suppliers. +Tirreno is a universal analytic tool for monitoring online platforms, web applications, SaaS, communities, IoT, mobile applications, intranets, and e-commerce websites. It is effective against external threats associated with partners or customers, as well as internal risks posed by employees or suppliers. * **For Website Owners**: Protect your user areas from account takeovers, malicious bots, and common web vulnerabilities caused by user behavior. * **For Online Communities**: Combat spam, prevent fake registrations, and stop re-registration from the same IP addresses. -* **For Startups, SaaS, and E-commerce**: Get a ready-made boilerplate for client security, including monitoring customer activity for suspicious behavior and fraud prevention based on advanced email, IP, and phone reputation checks. +* **For Startups, SaaS, and E-commerce**: Get a ready-made boilerplate for client security, including monitoring customer activity for suspicious behavior and preventing fraud using advanced email, IP address, and phone reputation checks. * **For Platforms**: Conduct thorough merchant risk assessments to identify and mitigate potential threats from high-risk merchants, ensuring the integrity of your platform. * **For IoT Security**: Enhance the security of your IoT ecosystem by tracking user activity and identifying potential vulnerabilities. -* **For CISOs and Security Teams**: Monitor employee accounts and secure critical enterprise applications like Mattermost™, GitLab™, CRM, or intranets. Identify unusual activity patterns or unauthorized access attempts. +* **For CISOs and Security Teams**: Monitor employee accounts and secure critical enterprise applications like Mattermost™, GitLab™, CRMs, or intranets. Identify unusual activity patterns or unauthorized access attempts. Tirreno is a "low-tech" PHP and PostgreSQL software application that can be downloaded and installed on your own web server. After a straightforward five-minute installation process, you can immediately access real-time analytics. @@ -37,7 +37,7 @@ Check out the online demo at [play.tirreno.com](https://play.tirreno.com) (admin If you prefer Apache web server, `mod_rewrite` and `mod_headers` should be enabled. -## Install instruction +## Installation instructions 1. [Download](https://www.tirreno.com/download.php) the latest version of Tirreno (ZIP file). 2. Extract the tirreno-master.zip file to the location where you want it installed on your web server. @@ -49,32 +49,31 @@ If you prefer Apache web server, `mod_rewrite` and `mod_headers` should be enabl */10 * * * * cd /path/to/tirreno && /usr/bin/php /path/to/tirreno/index.php /cron >> /path/to/tirreno/logs/error.log 2>&1 ``` -## User guide - -Please see the [Tirreno Docs](https://docs.tirreno.com/). +## Documentation +See the [User Guide](https://docs.tirreno.com/) for details on how to use Tirreno. ## Optional non-free capabilities The open-sourced Tirreno code is intended to be used for free as a standalone application. It provides general statistics and an extended audit log of user requests to a monitored system. As is, this tooling may be sufficient for bringing insights about user activity and behavioral patterns in a wide range of use cases, especially as a solution for small and medium-sized organizations. -However, if you are looking to cover more advanced usage scenarios, such as fraud prevention, the additional Tirreno API enrichment capabilities can be enabled via [monthly-paid subscription](https://www.tirreno.com/pricing/). +However, if you are looking to cover more advanced usage scenarios, such as fraud prevention, the additional Tirreno API enrichment capabilities can be enabled via [monthly-paid subscription](https://www.tirreno.com/pricing/). Depending on the subscription plan, it supplies extended information on any of the following: IP address, email address, domain, and phone number. Enabling all the data enrichment types augments Tirreno into a fully-fledged enterprise solution for an online fraud prevention system. -### Enrichment API +## Background -As the solution we built has proved to be efficient in guarding our platform, over time we have implemented a data enrichment API. The goal was to provide our partners and clients with ethical means in their struggle against malicious actors. +The business behind this platform is Tirreno Technologies Sàrl, operated in Vaud (Switzerland). It is a privately owned, for-profit company with no venture capital involved. The Tirreno project started as a proprietary system in 2021 and was open-sourced (AGPL) in December 2024. -We have built the Tirreno API in-house, eliminating the need to share information with third parties. It operates without collecting or storing user data. +The idea for Tirreno arose from a challenge: an online platform was in need of a fraud prevention tool. We were looking for a product that could work on-premises and would not share user data with third-party vendors. Since the available solutions did not meet all our requirements, we created our own tool. -Along with making Tirreno's code publicly available, we provide access to this API on a monthly subscription basis. Depending on the subscription plan, it supplies extended information on any of the following: IP address, email address, domain, and phone number. Enabling all the data enrichment types augments Tirreno into a fully-fledged enterprise solution for an online fraud prevention system. +While building Tirreno, we concentrated on **privacy**, **trust**, and true **sovereignty**. As a result, we have built Tirreno in a secure and independent manner. The application does not have a long list of development dependencies, nor does it rely on heavy frameworks. This approach minimizes the potential attack surface. -## Background +### Enrichment API -The business behind this platform is Tirreno Technologies Sàrl, operated in Vaud (Switzerland). It is a privately owned, for-profit company with no venture capital involved. The Tirreno project started as a proprietary system in 2021 and was open-sourced (AGPL) in December 2024. +As the solution we built has proved to be efficient in guarding our platform, over time we have implemented a data enrichment API. The goal was to provide our partners and clients with ethical means in their struggle against malicious actors. -The idea for Tirreno arose from a challenge: an online platform was in need of a fraud prevention tool. We were looking for a product that could work on-premises and would not share user data with third-party vendors. Since the available solutions did not meet all our requirements, we created our own tool. +We have built the Tirreno API in-house, eliminating the need to share information with third parties. It operates without collecting or storing user data. -While building Tirreno, we concentrated on privacy, trust, and true sovereignty. As a result, we have built Tirreno in a secure and independent manner. The application does not have a long list of development dependencies, nor does it rely on heavy frameworks. This approach minimizes the potential attack surface. +Along with making Tirreno's code publicly available, we provide access to this API on a [monthly subscription](https://www.tirreno.com/pricing/) basis. ### Why the name Tirreno?