System Requirements#
This page lists the requirements your environment must meet before installing Squirro. The requirements apply to all deployment types: on-premises and cloud.
The recommended installation method is Ansible, which automates the setup of most components. For installation instructions, see the Install and Manage Squirro with Ansible page.
Hardware#
System sizing requirements for disk space, CPU, and disk I/O are determined by the projected data volume and the number of concurrent users.
For detailed sizing guidance tailored to your deployment, visit the Squirro Support website and submit a technical support request.
Minimum requirements#
The following minimum requirements apply to proof-of-concept (PoC) and development installations:
Processor |
Intel Core i5 with 4 cores (x86_64) or higher, with AVX2 extensions. |
Memory |
16 GB or higher. |
Storage |
100 GB or higher, with a minimum read/write speed of 100 MB/s. |
Recommended specifications#
The following specifications apply to production installations:
Processor |
Intel Xeon or equivalent with 8 cores (x86_64) or higher, with AVX2 extensions. |
Memory |
64 GB. |
Storage |
500 GB or higher, with a minimum read/write speed of 100 MB/s. |
Linux#
Use locally attached SSD or NVMe storage for the Elasticsearch data directory. Network-attached storage with high latency (for example, software-defined storage or NAS solutions) causes significant performance degradation for Elasticsearch. Cloud block storage such as AWS EBS (gp3) or Azure Managed Disks is acceptable.
Disk Partitions and Directories#
A Squirro installation stores its configuration, data, and logs in a fixed set of directories. Knowing what each directory holds and how it grows helps you allocate storage and monitor free space.
Recommended Partition Layout#
The table below lists the recommended mount points for installing Squirro on supported Linux distributions. Placing the high-growth directories /var and /var/log on their own partitions prevents data or log growth from filling the root partition and affecting system stability. You can implement this layout using LVM (Logical Volume Manager) or other partitioning methods.
Mount point |
Primary contents |
Growth |
|---|---|---|
|
Operating system files and Squirro configuration. |
Static after installation. |
|
Squirro installation and Python virtual environment. |
Static, except during upgrades. |
|
System temporary files, including project exports. |
Grows with each project export until the operating system clears |
|
Search engine data, relational database, Redis data, container images, and Squirro application data. |
High, in proportion to the ingested data. |
|
System and application logs. |
Continuous. |
The storage figures in the Hardware section above apply to the total across all partitions. Size /var last and give it the remaining capacity, because it absorbs nearly all data growth. For a proof-of-concept or development installation, a single root partition is sufficient, as long as it leaves room for search engine data to grow.
For sizing guidance on individual partitions, visit the Squirro Support website and submit a technical support request.
Detailed Directory Breakdown#
This section lists the directories that a Squirro installation creates and uses, organized by partition. The search engine directories shown are those of Elasticsearch, the default search engine.
Root partition (/)#
Besides the standard Linux system directories, such as /bin, /usr, and /lib, the root partition holds the Squirro configuration:
/etc/squirroSquirro configuration files.
/etc/nginx/conf.dNginx web server configuration.
/etc/mysql/conf.dMariaDB configuration. When PostgreSQL is used instead, its configuration resides in the PostgreSQL data directory under
/var. For more information, see the Configure PostgreSQL as the Database Backend page./etc/redisRedis server configuration, for both the storage and the cache instance.
/etc/elasticsearchElasticsearch configuration.
Squirro installation partition (/opt/squirro)#
/opt/squirro/virtualenv<version>/Python virtual environment with all dependencies.
/opt/squirro/setup/Installation and setup scripts.
/opt/squirro/repo/Local package repository for offline installations.
/opt/squirro/elasticsearch/maintenance/Search engine maintenance utilities.
System temporary partition (/tmp)#
Project exports are staged and packaged in /tmp, and they remain there after the download until the operating system clears /tmp. Project imports also extract machine learning models and assets there while they run, and custom widget uploads are extracted there. If /tmp is a separate partition, leave room for repeated exports, not only for the largest one.
To stage these files elsewhere, for example on /var, set the TMPDIR environment variable in /etc/sysconfig/squirro to a directory that the Squirro service users can write to, then restart the Squirro services. For the required directory permissions, see the /etc/sysconfig page.
Variable data partition (/var)#
This is the largest partition and holds the primary Squirro data storage.
Search engine data:
/var/lib/elasticsearchAll indexed content, search indices, and analytics data. Place this directory on SSD or NVMe storage, as described in the Linux section above.
Relational database:
/var/lib/mysqlMariaDB data files for metadata, users, projects, and configuration. MariaDB is the default relational database.
/var/lib/pgsqlPostgreSQL data files, when PostgreSQL is used instead of MariaDB. For more information, see the Configure PostgreSQL as the Database Backend page.
Redis data:
/var/lib/redisRedis server data files for caching and message queuing.
Container data:
/var/lib/dockerDocker container images, volumes, and container storage for the services that run as containers. For more information, see the Container Runtime section below.
Squirro application data:
/var/lib/squirro/inputstreamData ingestion batches. By default, failed batches are kept for 30 days and processed batches for one hour. Failed batches account for most of the growth of this directory. Both retention periods are configurable. For more information, see the ingester.ini page.
/var/lib/squirro/tempGlobal temporary directory for caching and operations. Temporary files are removed automatically after about one hour by default, and the retention period is configurable. Project import archives are the exception: each one is kept until the next import into the same project.
/var/lib/squirro/topic/assetsCustom assets uploaded by users.
/var/lib/squirro/topic/widgetsCustom widget definitions.
/var/lib/squirro/machinelearning/pretrained_modelsMachine learning and NLP models.
/var/lib/squirro/storageGeneral storage location for file content, including binary documents. In a multi-node cluster deployment, this is the default mount path for the shared storage described in the Shared Storage section above.
Service-specific directories:
/var/lib/squirro/<service-name>Most Squirro services have their own data directory for service-specific state and working files. These directories typically remain small.
Job logs:
/var/lib/squirro/datasource/job_logsand/var/lib/squirro/machinelearning/job_logsJob execution logs for the data source and machine learning services. These logs are rotated daily, and seven rotations are kept. Log files that have not been accessed for 30 days are removed.
Growth characteristics: High growth. Search engine data and stored binary documents grow continuously with data ingestion. This partition requires the most capacity and regular monitoring.
Logs partition (/var/log)#
Squirro application logs:
/var/log/squirro/Squirro service logs, in one subdirectory per service. By default, each service log rotates at 50 MB and keeps three backups, so it occupies up to about 200 MB per service. A few services also write a structured JSON log with the same limit.
/var/log/squirro/frontendFrontend user activity logs and performance data.
Infrastructure logs:
/var/log/elasticsearchElasticsearch server, slow query, and garbage collection logs. Elasticsearch rotates these files itself.
/var/log/nginxNginx access and error logs for the main web server. The per-service Nginx logs reside under
/var/log/squirro/<service-name>/instead./var/log/mariadbMariaDB server logs.
/var/log/redisRedis server logs.
/var/log/dockerDocker daemon and container logs, when containerized services are used.
Warning
Log rotation does not cover every file on this partition. The stdout.log and stderr.log files in each /var/log/squirro/<service-name>/ directory are not rotated, and are emptied only when the service restarts. Size /var/log with headroom and monitor its free space, rather than relying on rotation alone to bound growth.
Growth characteristics: Continuous growth. Rotation bounds the size of most log files, but active systems still generate significant log volumes.
For the full list of log files and what each one records, see the Monitoring page.
Operating System#
Squirro runs on Linux. RPM packages are provided for Red Hat Enterprise Linux (RHEL) and its open-source derivative Rocky Linux.
Distribution |
Versions |
Architecture |
|---|---|---|
Red Hat Enterprise Linux |
8 and 9 |
x86_64 |
Rocky Linux |
8 and 9 |
x86_64 |
RHEL installations require an active Red Hat subscription so that Yum can install packages from the default distribution repository. Installation also requires credentials to access the Squirro YUM repository at mirror.squirro.net. To obtain your credentials before starting the installation, visit the Squirro Support website and submit a technical support request.
Java#
Squirro requires Java 21. The search engine (Elasticsearch or OpenSearch) runs on the JVM, so the java-21-openjdk package must be installed on every node before the Squirro packages are installed. When using the Ansible role, Java is installed automatically.
Network Requirements#
Firewall ports#
Open the following TCP ports on all servers before installation.
TCP port |
Usage |
Open for |
|---|---|---|
9200 |
Search engine access (Elasticsearch or OpenSearch). |
All storage and Squirro nodes. Restrict to cluster nodes only. |
9300 |
Search engine cluster communication (Elasticsearch or OpenSearch). |
All storage nodes. Restrict to cluster nodes only. |
TCP port |
Usage |
Open for |
|---|---|---|
80 |
Web access (HTTP, redirects to HTTPS). |
All Squirro nodes. Do not expose to clients in production. Nginx redirects HTTP to HTTPS. |
111 |
Shared filesystem. |
All Squirro nodes (multi-node setups only). |
443 |
Web access (HTTPS). |
All clients. |
2049 |
Shared filesystem. |
All Squirro nodes (multi-node setups only). |
3306 |
MySQL/MariaDB. |
All Squirro nodes. |
5432 |
PostgreSQL (when used instead of MariaDB). |
All Squirro nodes. |
6379 |
Redis (storage). |
All Squirro nodes. Restrict to cluster nodes only. |
6380 |
Redis (cache). |
All Squirro nodes. Restrict to cluster nodes only. |
445 |
Shared filesystem. |
All Squirro nodes (multi-node setups only). |
25 |
SMTP (email notifications, outbound). |
SMTP server. |
587 |
SMTP with STARTTLS (email notifications, outbound). |
SMTP server. |
Port numbers may vary depending on the cloud provider or additional software components. For guidance on custom deployments, visit the Squirro Support website and submit a technical support request.
Elasticsearch (ports 9200 and 9300) and Redis (ports 6379 and 6380) must be reachable only from within the Squirro cluster. Restrict these ports at the network or security-group level and do not expose them to client or public networks. Squirro configures password authentication for both Redis instances, but network isolation is the primary defense layer.
Outbound internet access#
The server requires outbound internet access on TCP ports 80 and 443 to reach the following domains during installation and upgrade:
# Operating system packages (Rocky Linux)
https://*.rockylinux.org
# Operating system packages (Red Hat Enterprise Linux)
https://*.redhat.com
# Squirro RPM packages
https://mirror.squirro.net
# Squirro container images
https://registry.squirro.com
# Ansible roles and modules
https://galaxy.ansible.com
https://ansible-galaxy-ng.s3.dualstack.us-east-1.amazonaws.com
# Python packages
https://pypi.org
https://bootstrap.pypa.io
https://files.pythonhosted.org
# Source code and dependencies
https://github.com
https://*.github.com
For air-gapped environments that cannot reach the internet, offline installation packages are available from the Squirro mirror. For more information, see the Install and Manage Squirro with Ansible page.
Database#
Squirro uses MariaDB (MySQL-compatible) as its default relational database. The Ansible installation role installs and configures MariaDB automatically.
PostgreSQL is supported as an alternative to MariaDB. For setup instructions, see the Configure PostgreSQL as the Database Backend page. For version-specific compatibility questions, visit the Squirro Support website and submit a technical support request.
Search Engine#
Squirro uses Elasticsearch 9.x as its default search and indexing engine. The Ansible installation role installs and configures Elasticsearch automatically.
OpenSearch is supported as a technical preview alternative. Technical preview means the feature is functional but not yet recommended for production deployments. Support coverage is limited, and behavior may change in future releases.
Elasticsearch requires AVX2 CPU extensions. Verify that your hardware meets this requirement before installation. The processor specifications in the Hardware section above already account for that.
Elasticsearch allocates a JVM heap from available system memory. For optimal performance, plan for at least 50% of RAM to be available to the search engine process, up to a maximum heap of 32 GB. On a 64 GB server, that leaves sufficient memory for the remaining Squirro services.
Container Runtime#
Some Squirro services run inside containers. The following services are provided as containers only:
GenAI.
The following services can optionally run as containers:
Plumber.
Transformers.
The squirro-python311-squirro.service.genai RPM package does not declare an explicit dependency on a container runtime, allowing you to choose any OCI-compatible runtime such as Docker or Podman. If you install Squirro using the Ansible role, Docker is installed and configured automatically. For manual installations, install a supported OCI runtime before installing the GenAI package.
GenAI and LLM Access#
GenAI features require access to a large language model (LLM). The server must be able to reach the chosen LLM API endpoint over HTTPS (port 443).
For the full list of supported providers, compatibility requirements, and model recommendations, see the Large Language Model Support page.
Identity Provider#
Single sign-on (SSO) is recommended for all production deployments. Squirro supports SAML 2.0 for identity federation. Plan the SSO integration with your IT team before deployment. The Squirro implementation team can assist with identity provider configuration.
For deployments where SSO is not available, Squirro provides local username and password authentication as a fallback.
Note
Squirro strongly recommends configuring SSO before moving a production deployment live, and planning the integration as part of the deployment rather than afterward. For setup instructions, see the External Authentication page.
DNS#
Squirro requires a DNS hostname for production deployments. Plan with your IT team to create a DNS record pointing to the server IP address or load balancer before deployment. That hostname is also used for the SSL/TLS certificate. DNS provisioning can take time depending on your organization’s internal processes. Initiate the request at least two to three weeks before your target installation date.
SSL/TLS Certificates#
Squirro uses Nginx as its reverse proxy and requires an SSL/TLS certificate for HTTPS access. Obtain a certificate signed by a certificate authority (CA) trusted by your organization before deployment. A self-signed certificate is installed by default and is suitable for initial testing only. Certificate issuance through an internal CA or a public CA can take time. Initiate the request at least two to three weeks before your target installation date.
Squirro communicates with Elasticsearch over port 9200. TLS for that traffic, as well as inter-node TLS in multi-node setups, requires additional certificates. For configuration details, see the Secure Elasticsearch with SSL/TLS page.
Email#
Squirro sends email notifications for digest reports and alerts. An SMTP server accessible from the Squirro node is required. Before deployment, confirm with your IT team that the Squirro node can reach the SMTP server on the required port (typically port 25 or 587). The default configuration expects a local SMTP relay on port 25.
Deployment Topology#
A single-node deployment is suitable for uptime SLAs up to 99.9%. For higher SLA targets, a multi-node topology with managed database and cache services is required.
Squirro supports two node roles:
Storage node
Stores indexed data using Elasticsearch. Add storage nodes to increase capacity.
Cluster node
Handles user requests and data processing. Add cluster nodes to increase throughput.
In a single-node setup, both roles run on the same server. In a multi-node setup, Squirro recommends running each role on dedicated servers for more flexible scaling.
For cloud deployments, Squirro recommends a minimum of three instances for production use: one dedicated storage node running Elasticsearch, and two cluster nodes handling user requests and data processing. That configuration provides a baseline for redundancy at the application layer.
Client Browsers#
Squirro runs in a web browser. The following browsers are supported:
Browser |
Version |
|---|---|
Microsoft Edge |
Latest version |
Google Chrome |
Latest version |
Mozilla Firefox |
Latest version |
Apple Safari |
Latest version |
Squirro does not support older browser versions.