Install or Upgrade Server

Last modified: August 11, 2021

Before installing and activating Server, verify your network has access to all required licensing system domains. Go to Licensing System Requirements for a complete list.


To install and run Server, your system has to have these prerequisites.

  • Review the System Requirements for Server. 
  • Ensure the computer can contact the web domain used by the Alteryx licensing system.
  • Admin access to the host server's operating system or physical access to the server hardware.
  • Read access to Active Directory, if you plan to use Integrated Windows Authentication Visit the Gallery Authentication help page to learn more about authentication options.
  • Read and write permissions to the file share.
  • Alteryx admin user.

Download Server Installation File

Download the Server product from the Alteryx Downloads and Licenses portal.

  1. Sign in to the Alteryx Downloads and Licenses portal at
  2. Under Product Downloads, select Alteryx Server.
  3. On the Download Products page, select the version of the product you want to download. The latest version is available on the New Versions tab. Access previous versions on the Previous Versions tab.
  4. On the Downloads page, select the plus icon next to Alteryx Server to display a description of the product.
  5. Select the link for the Alteryx Server product in the File Name column to download the file.

Install Server

  1. Run the Alteryx Server Installer with admin rights. (Right-click and select Run as administrator.)
  2. Confirm the destination folder and select Next.
  3. Check the I accept the license agreement checkbox and select Next.
  4. Select 1 of these options and select Finish.
    • Configure Server now: Opens the System Settings window to configure Server.
    • Close and run Alteryx Designer later: Closes the installation window. Access the system settings at any time via the Alteryx System Settings desktop icon.
    • Install Predictive Tools: Installs the predictive tools in Designer. The predictive tools use R, an open-source programming language used for statistical and predictive analysis. Select this option to launch the R installer. You have to install the predictive tools to use the predictive macros in Designer. To install at a later time, go to Options > Download Predictive Tools in Designer.

We recommend you install all Server components on a separate, physical drive (for example, D:) from the OS install. To avoid latency, use a local, solid-state drive not a network drive. Assign all workspaces and directories to use the same drive as the installation.

Benefit: This minimizes input/output contention with OS operations.

License Your Server

If you haven't licensed your Server, you are prompted to do so. Use the license key from your license administrator to activate a product license. If the license prompt doesn't immediately load, you can access it in Designer under Options > Manage Licenses > Activate New License.

Activate Online
  1. In the Alteryx Server Activation window, enter your email address.
  2. Enter your License keys one per line.
  3. Select Activate.
  4. In the Activation Success window, select Experience Alteryx.
Activate Offline

As an alternative to online activation, you can submit a request for an activation (BIN) file. If you want to activate with a file, select Activate with File to open the Alteryx Offline Activation window.

Step 1. Create a Request (REQ) File from the Offline Computer

  1. Open Designer. If the Alteryx Designer Activation window doesn't open, select Options > Manage Licenses > Activate New License.
  2. Select Activate Offline.
  3. In the Alteryx Offline Activation window, select Create in the Request step to create a request (REQ) file.
  4. Enter your First nameLast nameEmail address, and your License keys.
  5. Select Create request. Alteryx creates a request file with your email address and REQ extension as shown in this example:
  6. Select Save to save the request (REQ) file where it can be accessed from the Alteryx Downloads and Licenses portal or send the file to your license administrator.

Step 2. Upload the Request File to the Alteryx Downloads and Licenses Portal

This step requires internet access.

  1. Sign in to the Alteryx Downloads and Licenses portal at
  2. On the Home page, select Upload Activation Request.
  3. Select Browse and select the request (REQ) file you saved in the previous step.
  4. The Alteryx Downloads and Licenses portal generates an activation file with your email address and BIN extension as shown in this example:
  5. Save the activation (BIN) file so that you can access it from the offline computer.

Step 3. Open the Activation (BIN) File on the Offline Computer

  1. In the Alteryx Designer Activation window on the offline computer, select Back.

    Or, select Options > Manage Licenses > Activate New License to open the Alteryx Offline Activation window.

  2. Select Browse and select the activation (BIN) file.
  3. In the Activation Success window, select Experience Alteryx.
Activate Using a License Server

The Alteryx License Server allows for the hosting and managing of purchased product licenses within an organizations' internal network. The license server allows for smoother and more-secure deployment of Alteryx products, especially behind proxies and firewalls. Download the license server from the Alteryx Downloads and Licenses portal at

  1. Open Designer. If the Alteryx Designer Activation window doesn't open, select Options > Manage Licenses > Activate New License.

    If you don't have valid licenses, the license server displays Install License. Select OK to continue.

  2. Select the here link within To access your License Server, click here text. The license server displays Manage Licenses.
  3. In License Server Connectivity, select Connect. The license server displays available licenses. If this is the first time you have activated a license, enter your email address.​​​​​​
  4. Select Activate for each product you want to activate.
  5. Select Close.

For more help including command line options, go to Product Activation and Licensing Help.

Upgrade Server

Before You Upgrade

  • Embedded MongoDB Version Support & Migration: The embedded MongoDB database uses one of these MongoDB versions: 3.0, 3.4, or 4.0. The version of MongoDB depends on what version of Server you have installed. To successfully migrate data to a new version of Server, you have to make sure that MongoDB upgrades consecutively to each newer version that we support. So, to upgrade from 3.0 to 4.0, you have to upgrade from 3.0 to 3.4 and then to 4.0. To accomplish this, make sure that you install versions of Server that support each of those versions of MongoDB. It doesn't matter what version of Server you upgrade to, as long as it supports the correct version of MongoDB. Go to the Server Version to MongoDB Version Crosswalk to review which MongoDB versions are supported in each Server version.
  • User-Managed MongoDB Support: Check the Server Version to MongoDB Version Crosswalk to ensure that your MongoDB version is supported in the version of Server you are upgrading to.

  • Server Version to Version Upgrade Support: You can't upgrade directly from version 11.7 or older to version 2021.1+. If you are using Server version 11.7 or previous and want to upgrade to 2021.1+, you have to first upgrade to version 2020.4 or previous. Then you can upgrade to 2021.1+.

  • Maintenance Mode Forced for Server UI due to MongoDB Issues: It is essential to backup the MongoDB before upgrading as Server should enter a maintenance mode any time a schema migration is required. It will not allow Server to enter a functional state until the schema migration completes. If the migration continues to fail due to any unforeseen circumstances, Server will stay in a maintenance mode or shut down after a number of retries.  
    For example, the migration could be prevented from taking place due to duplicate records in the MongoDB. To solve this particular issue, go to the Community article Gallery Not Starting after Upgrading to 2021.2 - Error: Duplicate Key

Follow these steps to upgrade to a newer Server version:

  1. Stop the AlteryxService.
    1. Open Task Manager.
    2. Select the Services tab. 
    3. Locate the AlteryxService
    4. Right-click and select Stop.
  2. Perform a backup of the MongoDB. Go to MongoDB Backups.
  3. Follow the download and install steps to upgrade to a newer version of Server.
  4. If you are upgrading to a Server version that uses another MongoDB version, select Migrate Mongo Database to run the migration utility during the install process to update the MongoDB version. Go to the MongoDB Schema Reference for a table showing what MongoDB versions correspond with Server versions.
    Screenshot of Install screen highlighting the Migration Mongo Database option

The Alteryx Service should automatically start after the upgrade. The Alteryx Service has to be running to access the Gallery. If you can't access Gallery, confirm the Alteryx Service has restarted. 

  1. Open Task Manager.
  2. Select the Services tab. 
  3. Locate the AlteryxService.
  4. Confirm the Status shows Running.
  5. If the Status shows Stopped, right-click and select Start.

What's Next?

Configure Server from the System Settings.

Was This Page Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support. Can't submit this form? Email us.