System Requirements
Server is supported on desktop computers, stand-alone servers, and virtual machine environments with the following minimum requirements.
Hardware
Minimum Requirements Per Server Node | Recommendations for Production Environments Per Server Node (Multi-Node Environment)* | |
---|---|---|
CPU | Intel or AMD x86-64 (64-bit) | Intel Xeon E, Xeon W, AMD EPYC 7xx2, AMD Threadripper, or better |
Number of CPU Cores** | 4 cores (8 logical cores) per node Example Environment:
| 8+ cores (16+ logical cores) per node Example Environment:
|
System Memory | 16 GB | 32+ GB |
Recommended Minimum Disk Size | 500 GB | 1+ TB SSD |
*Enterprise Production Deployments vary per use case. For assistance assessing hardware sizing needs, talk to your Alteryx representative. Learn more in this whitepaper and our Configuration Page.
**This table assumes 1 physical core to be equal to 2 logical cores. For more information, please see our licensing definitions page.
We’ve separated our recommendations into 2 different categories: Minimum Hardware Requirements and Recommended Hardware for Optimal Performance.
Minimum Hardware Requirements
Server minimum hardware requirements are defined as the minimum hardware needed to run a stable installation of Alteryx Server. If you don't meet minimum requirements, it puts you at risk of having poor performance and/or having the service shut itself down on any node where the engine runs.
The following minimum hardware requirements are recommended for desired number of concurrent workflows:
Note that the green highlighted line is the minimum recommended configuration. The line showing information for 1 concurrent workflow is helpful for you to understand how much you need to increase resources to add 1 additional job to the existing configuration.
Recommended Hardware for Optimal Performance
Server optimal performance hardware recommendations are defined as the sweet spot in hardware where Server can complete workflows as efficiently as possible. This is useful to eliminate congestion on busy systems.
The following hardware recommendations are recommended for optimal performance:
*Logical cores are either vCPUs or logical cores within a physical core. The standardization to refer to logical cores is a way of comparing consistently across both physical on-prem servers and virtual servers in the cloud.
Software
Windows Server 2012 End of Support
As of Server version 2023.2, Alteryx no longer supports Windows Server 2012 as it has reached the end of support by Microsoft. Go to Windows Server 2012 and 2012 R2 reaching end of support to learn more.
Microsoft Windows Server 2016 64-bit or later
Microsoft .NET Framework 4.6 or higher
Install Predictive Tools to run workflows that use the Predictive Tools on Server.
FIPS mode disabled.
Databases
Important
The Persistence or Database Layer can be implemented using either a user-managed MongoDB or MSSQL database. Alteryx provides a default MongoDB with its Server products, located on the Controller node and referred to as Embedded MongoDB.
While Embedded MongoDB is often sufficient, a properly implemented user-managed database can offer performance and reliability improvements. However, a user-managed database requires the organization to invest significantly in skills and resources to implement, maintain, and support it.
With Embedded MongoDB, Alteryx provides a pre-tested, reliable database configuration with full visibility and support. In contrast, a user-managed database requires the user to handle all aspects of database setup, management, configuration, and, importantly, troubleshooting.
Alteryx can advise on user-managed databases that are compatible with Alteryx Server. However, the organization is responsible for managing the database, including having an available and knowledgeable administrator to troubleshoot any issues. Alteryx has no access to the logs or files of user-managed databases, which are essential for diagnosing issues in Embedded MongoDB.
Additionally, it is the responsibility of the user-managed database to be tuned and optimized to meet the performance needs of the Alteryx application.
MongoDB
Server configuration requires MongoDB. For more information about MongoDB versions, go to MongoDB Schema Reference.
Embedded MongoDB:
If you are upgrading from a version prior to 2021.3.6, you must start with a version of Server that uses MongoDB 4.0 before you upgrade to 2021.3.6 version or higher. Versions of Server that use embedded MongoDB include 2019.3 through 2021.3.5.
For embedded MongoDB, the host, username, and password are automatically generated.
User-Managed MongoDB:
Server supports MongoDB versions 4.2, 4.4, 5.0, 6.0, and 7.0 for user-managed instances.
For user-managed MongoDB, specify the host, username, and password from your MongoDB instance.
If you were previously using SQLite for Alteryx Scheduler, jobs have to be manually re-scheduled when switching to MongoDB.
For more information, visit the MongoDB Schema Reference help page.
SQL DB
Currently, the only officially supported version of SQL is MSSQL Server 2019 and 2022. Your SQL database administrator can determine the appropriate MSSQL Server edition and sizing for your database, whether Standard or Enterprise.
You must have an MSSQL Server instance hosted and network accessible from your Alteryx Server controllers.
We recommend using a separate SQL database for AlteryxGallery / AlteryxService to access.
The SQL DB access user needs full control (admin level ) for any SQL DBs Alteryx Server will be using.
The version of Server you are upgrading to 2024.1 from must be 2022.1+ GA or 2022.3+ FIPS.
If you use built-in authentication and you upgrade from a version lower than 2022.1, you need to reset your password due to security improvements. If you didn't reset your password in version 2022.1, you need to have SMTP enabled. This is so users can reset their password via the forgot password functionality or so that an admin can trigger password resets for all users via the UI or API. For more information on how to reset your Server password after an upgrade to 2022.1, visit the Reset a User's Server Password help page.
You must install SQL Server drivers. For more information, go to Mongo to SQL Migration Guide.
Optional: Access to SQL Server Management Studio.
This allows you to view/access database data manually, so you can verify and validate the state of your data without having to go into your Server.
For more information on how to migrate from MongoDB to SQL DB, go to Mongo to SQL Migration Guide.
Ports
These are the default ports used by Server. You can customize Server ports if necessary.
Public | |
---|---|
80 | AlteryxService, Non-SSL/TLS AlteryxServerHost (webserver), and AlteryxAuthHost (Authentication Service) |
443 | AlteryxServerHost (webserver) and AlteryxAuthHost (Authentication Service) with SSL/TLS |
27018 | Embedded MongoDB |
Loopback Only | |
---|---|
5562 | AlteryxMetrics |
8700-8799 | Python for Insights |
Permissions
Administrator Rights | Admin access to the host server's operating system or physical access to the server hardware is required to install Server. |
Active Directory Read Access | Read access to Active Directory, if you plan to use Integrated Windows Authentication. Visit the Server Authentication help page to learn more about authentication options. |
Access to Alteryx Licensing System | Ensure the computer can contact the whitelist.alteryx.com web domain used by the Alteryx licensing system. |
File Share Access | Read and write permissions to the file share. |
Alteryx Admin User | The Server administrator can manage users and workflows. A Default Server Admin is specified when configuring the authentication for the Server. Visit the Server Authentication help page to learn more about specifying a Default Server Admin. |
Run As User | In hardened server environments with restrictive permissions policies, you might need to enable Windows Server security permissions in support of run-as credentials. Configure Required Run As User Permissions. |
Base Address and SMTP
Base Address—The base address is the URL that users use to access the Server—the URL defaults to http://localhost/gallery/ which you can use to run the Server locally.
SMTP Server—SMTP host information is required for Server email notifications. Notifications and account validations are managed via email.