farmOS Server Requirements

Note: These requirements are for hosting farmOS on a live production server. For local development/testing, please refer to the development environment documentation.

Docker is the recommended method of hosting farmOS because it encapsulates the web server requirements described below. For more information, refer to the farmOS in Docker documentation.

Web server

farmOS is based on Drupal, and therefore shares many of the same requirements.

In addition to Drupal's basic requirements, farmOS has the following server dependencies. The farmOS Docker images include these.

• PHP 8.4
• PHP configuration - The following PHP settings are recommended:
  • memory_limit=256M
  • max_execution_time=240
  • max_input_time=240
  • max_input_vars=5000
  • realpath_cache_size=4096K
  • realpath_cache_ttl=3600
• PHP extensions - The following PHP extensions are required:
  • BCMath
  • EXIF
  • GEOS
  • SimpleXML

Database server

A database server needs to be provisioned that farmOS can connect to. PostgreSQL is recommended. MySQL/MariaDB and SQLite are also supported.

This can be installed on the same server as farmOS (either directly or in a Docker container), or it can be on a separate server.

Minimum version requirements:

• PostgreSQL 16+
• MariaDB 10.6+
• MySQL/Percona 8.0+
• SQLite 3.45+

See [farmOS in Docker][/hosting/docker/] for an example configuration that runs a PostgreSQL database Docker container alongside a farmOS container.

SSL

Although not strictly a requirement, some features (like the "Geolocate" button on maps) will only work over a secure connection. SSL is also recommended if you are streaming sensor data into farmOS, to keep your sensor's private key a secret.

A common strategy is to use Nginx as a reverse proxy with SSL termination, which listens on port 443 and forwards to farmOS on port 80. Let's Encrypt is a good option for free SSL certificate issuance, and renewal can be automated via cron.

These resources may be helpful:

• Drupal HTTPS Information
• Reverse Proxy Forum Post - Includes links to related GitHub issues and examples of how others have configured reverse proxies serving HTTPS.
• Local HTTPS - Documentation for running an Nginx reverse proxy with self-signed certificates for local farmOS development with HTTPS.

Satellite map layers

farmOS includes optional Mapbox and Google Maps modules that add satellite imagery base layers to the map. These can be installed in Setup > Modules, and configured in Setup > Settings > Map > Mapbox / Google Maps.

Both Mapbox and Google Maps require an API key to use their layers. Refer to the links below for instructions.

Obtaining Map API keys

• Mapbox: Access tokens
• Google Maps: Set up the Map Tiles API

Browser

Unless otherwise noted, farmOS is compatible with all modern browsers, and aims to support the same versions as Drupal core.