System Requirements

System Requirements

FusionAuth will install and run on nearly any system. We have done our best to document the supported configurations here. If you have any questions about platform support, please ask a question on the forum or open an issue on Github. If you have a licensed edition you may open a support request from your account.

Please read through this documentation and ensure you have met all of the requirements before continuing with the installation of FusionAuth.

• Operating System

• Java

• Compute RAM

• Compute Disk Space

• Compute CPU

• Database

  • Database RAM

  • Database Disk Space

• Elasticsearch

  • Elasticsearch RAM

  • Elasticsearch Disk Space

• Network Access

  • Paid Editions

Operating System

FusionAuth will run on most platforms. The following list summarizes the supported platforms.

• Linux - all distributions

• macOS 10.15 (Catalina) or newer

• Windows Server 2019

• Windows 10

Docker, k8s and other container platforms are supported because the host operating system is based upon Linux.

Java

FusionAuth ships with its own version of Java. The version that is contained in the bundle is the required and supported version.

Currently, Java 17 is the supported major version. Java 14 is the supported major version for all FusionAuth releases before FusionAuth 1.32.

To determine the Java version required for any given version of FusionAuth, download the appropriate FusionAuth package and examine the install script.

Compute RAM

The minimum memory required to run FusionAuth will vary depending upon the number of users you expect and the general intended system capacity.

General guideline: 512M

If you have memory lying around, feel free to throw more at it - but in a multi-node configuration 512M to 1GB assigned per node should be very adequate.

If you intend to run Elasticsearch and FusionAuth on the same host you will need to ensure the host has adequate memory for both services and ensure you have adequate disk space for the Elasticsearch index to be stored.

Considerations that may require a larger amount of memory:

• Bulk importing users into FusionAuth. If you are importing in chunks of 250k to 500k it is possible FusionAuth will require additional memory to complete this request.

• > 1k Lambdas. Lambdas need to be pre-compiled, cached and sandboxed in their own JavaScript engine for use a runtime. Creating thousands of Lambdas will increase your memory requirements due to what is needed to keep in memory at runtime.

• > 1k Tenants. There are tasks that require a full traversal of all tenants, when you have 1000’s of tenants these tasks may affect performance and will increase your memory requirements.

• > 1k Applications. There are tasks that require a full traversal of all applications, when you have 1000’s of applications these tasks may affect performance and will increase your memory requirements.

• When using the Advanced Threat Detection feature, a minimum of 2GB of heap is required, and 3GB is recommended.

Compute Disk Space

The minimum disk space for a compute node (that is nodes that are running fusionauth-app) required to run FusionAuth can generally be minimal. We recommend providing compute nodes with between 10GB and 50GB of disk space. The fusionauth-app installation is only a few hundred megabytes and the operating system is usually on a gigabyte or two. Therefore, you only need to provide enough space for logging and operations performed on the server.

This recommendation assumes that you aren’t running fusionauth-search on the node and leveraging Elasticsearch. If you intend to use Elasticsearch, please see the disk space recommendations below.

Compute CPU

The CPU required for compute nodes (that is nodes that are running fusionauth-app) depends mostly on the login and registration volume you expect and the password hashing algorithm you use. Here are some general guidelines based on AWS EC2 nodes and using PBKDF2 with a load factor of 24,000 for the password hashing algorithm:

Database

• MySQL 8.0 or newer

  • MysQL platforms that utilize MySQL Group Replication are not supported.

  • MariaDB and Percona may work, however these variants are not actively tested against by FusionAuth.

  • See MariaDB known issues on our GitHub issues.

• PostgreSQL 10 or newer

Elasticsearch

Elasticsearch is optional, and may be leveraged for improving user search functionality. See the Core Concepts - User documentation for reference in configuration and usage.

If you will be running Elasticsearch on the same host as FusionAuth, please ensure there is adequate RAM for both services to operate normally. Elasticsearch may also protect the index by moving it to read-only if the underlying host is running low on disk space, ensure you have plenty of free storage for the Elasticsearch index.

You can use the fusionauth-search package or any other Elasticsearch service including a cloud hosted service or just downloading it and installing it yourself from elastic.co.

Versions 6.3.x - 7.17.x are currently supported.

Later versions may work as well but may not have been tested for compatibility.

OpenSearch version 2.x should also function properly with FusionAuth version >= 1.42.0.

Network Access

FusionAuth downloads the MySQL JDBC driver at install time. Due to the drivers' licensing, it cannot be bundled into the application. Prior to 1.16.0, the drivers were downloaded no matter which database you used. After that version, they are only downloaded if you are using MySQL.

If you are running FusionAuth in an environment with no network access and are using MySQL, you must download the MySQL driver jar file and place it in fusionauth-app/web/WEB-INF/lib.