AvePoint Docs
Contact support
Contact support
English

Home > Get Started > Setup of AvePoint Cloud Index Gateway Admin in On-Premises Environments

Export to PDF

Setup of AvePoint Cloud Index Gateway Admin in On-Premises Environments

Global administrators can refer to the sections below to complete the setup of the AvePoint Cloud Index Gateway Admin in on-premises environments.

System Requirements

Before installing AvePoint Cloud Index Gateway Admin, make sure your server meets the following prerequisites.

ComponentPrerequisites
Operating System VersionWindows Server 2012, Windows Server 2012 R2, Windows Server 2016, Windows Server 2019, or Windows 10.
Available Disk Space1 GB or more
.NET Framework VersionThe .NET Framework 4.7.2 (or later) must be installed.
.NET Framework FeaturesThe Windows features, including .NET Framework 3.5.1, HTTP Activation, and Non-HTTP Activation must be installed.
Windows Process Activation ServiceThe Windows Process Activation Service must be started. Process Model, .NET Environment, and Configuration APIs must be installed.
World Wide Web Publishing ServiceThe World Wide Web Publishing Service must be started.
Web Server (IIS) RoleFor Windows Server 2012, Windows Server 2012 R2, Windows Server 2016, Windows Server 2019, or Windows 10: The following Windows features should be installed:● Web Server● Common HTTP Features (Static Content, Default Document)● Application Development (all versions of ASP.NET, all versions of .NET Extensibility, ISAPI Extensions, ISAPI Filters)● Management Tools (IIS Management Console, IIS Management Compatibility, IIS Metabase Compatibility)● Security (Windows Authentication)
IIS Admin ServiceThe IIS Admin Service must be started.

Assign a Public URL to the AvePoint Cloud Index Gateway Service

Assign a public URL that will be mapped to the AvePoint Cloud Index Gateway Service. The public URL for the gateway service is used to communicate with AvePoint Online Services, which are in Microsoft Azure. Make sure that the public URL can be used to access the AvePoint Cloud Index Gateway Service through the Internet.

Apply for a Certificate for the AvePoint Cloud Index Gateway Service

Apply for a certificate for the AvePoint Cloud Index Gateway Service from the Certificate Authority. Note the following information when applying for the certificate:

- **Issued To** – Must be the same as the host of the public URL for the AvePoint Cloud Index Gateway Service. - **Password** – Must be a certificate with a password. (The password is required when installing the AvePoint Cloud Index Gateway Admin.)

Install AvePoint Cloud Index Gateway Admin

Follow the steps below to install AvePoint Cloud Index Gateway Admin.

  1. Log into AvePoint Online Services and navigate to the AvePoint Cloud Index interface to download the AvePoint Cloud Index Gateway Admin package.

    • If this is the first time you are accessing AvePoint Cloud Index, or you have not configured Gateway Settings before, you will be brought to the Gateway Settings page directly. Click the download link to download the AvePoint Cloud Index Gateway Admin package file.

    • If you have configured Gateway Settings, click the Settings (gear) button on the upper-right corner of the page and select Gateway Settings from the drop-down list to access the Gateway Settings page. Click the download link to download the AvePoint Cloud Index Gateway Admin installation file.

  2. Extract the package on the local server where you want to install the AvePoint Cloud Index Gateway Admin. Double-click the Setup.exe in the extracted directory. The Welcome page appears.

    *Note: Ensure that the local server has been added to your domain.

  3. Click Start to install the AvePoint Cloud Index Gateway Admin.

  4. On the Subscription Agreement page, carefully review the subscription agreement. After you have read the agreement, select the I accept the terms in the subscription agreement checkbox. Click Next.

  5. On the Installation Location page, choose a location for the AvePoint Cloud Index Gateway Admin installation. You can use the default installation location (C:\Program Files\AvePoint), or you can click Browse and select another drive/location for the installation. Click Next.

  6. On the Installation Prerequisite Scanning page, AvePoint Cloud Index Gateway Admin will perform a brief scan of the environment to ensure that your environment meets the installation prerequisites. The status for each prerequisite will be listed in the Status column. Click the link of the status to view more information about the scan results.

    If any prerequisites fail the scan, update your environment to meet the requirements, and then click Rescan to check your environment again. Once all prerequisites have passed, click Next.

  7. On the Website Configuration page, set up the website configurations.

    • IIS Website Settings – Configure the IIS website settings. You can choose to use an existing IIS website.

      *Note: AvePoint recommends that you create a new IIS website for the AvePoint Cloud Index Gateway Admin. Using an existing IIS website may affect applications that currently use this website.

      • Use an existing IIS website – Select an existing IIS website from the drop-down list. You can adjust the Website Port used to access the gateway service if necessary.

      • Create a new IIS website (Recommended) – Enter the website name and create a new IIS website. The default Website Port used to access this service is 19000, and you do not need to change it unless a known port conflict exists.

      • Website Port – Service communication port which is used to access the AvePoint Cloud Index Gateway Service and communicate with AvePoint Online Services.

      • Website Certificate – Choose the website certificate used to verify the site’s validity and enter the certificate’s password. Refer to Apply for a Certificate for the AvePoint Cloud Index Gateway Service for details about the certificate’s requirements.

    • Application Pool Settings – Configure the IIS application pool settings for the website you are creating. The application pool processes all of the requests sent to the website, such as requests for loading pages and files, uploading files, deleting files, downloading files, and configuring settings. You can use an existing application pool or create a new one.

      *Note: AvePoint recommends that you create a new IIS application pool. Using an existing IIS application pool may affect the features of the applications that currently use this application pool.

      • Use an existing application pool – Select an existing application pool from the drop-down list. If using an existing application pool, the Application Pool Account settings are greyed out and cannot be changed.

      • Create a new application pool (Recommended) – Enter the application pool name and application pool account settings to create a new IIS application pool for the website.

        *Note: The application pool account must have been added to your domain. This account requires Read and Write permissions to the AvePoint Cloud Index Gateway Admin installation directory, and Read permission to the Registry (HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\ Uninstall\AvePoint Cloud Index Administration).

    Click Next to continue.

  8. On the Database Configuration page, set up the database settings. AvePoint Cloud Index Gateway Admin only supports MS SQL databases.

    The following SQL Server versions are supported: SQL Server 2005, SQL Server 2008, SQL Server 2008 R2, SQL Server 2012 RC/RTM, SQL Server 2014, SQL Server 2016, and SQL Server 2019.

    *Note: It is not recommended to use SQL Server Express databases as the performance will be affected.

    • Database Server – The MS SQL Server name.

    • Database Name – Enter a database name for the service. If the database does not exist, it will be automatically created in the configured MS SQL Server entered above.

      *Note: If you are about to use a Microsoft Azure database, the database must be an existing one.

    • Database Credentials – Select the credentials for the database.

      • Windows Authentication (the default option) – Use this method if you want the user’s identity to be confirmed by Windows. This account must have either the dbcreator server role in the SQL Server that will contain the new database or the db_owner database role in an existing database.

      • SQL Authentication – SQL Server will confirm the user’s identity according to the user’s account and password. The account must have the following permissions: db_owner database role in an existing database or dbcreator server role in the SQL Server that will contain the database.

    Click Next to continue.

  9. On the Gateway Service Public URL Configuration page, set up the public URL for AvePoint Cloud Index Gateway Service.

    • Public URL of Gateway Service – Enter the public URL of the AvePoint Cloud Index Gateway Service. For details about how to assign a public URL for AvePoint Cloud Index Gateway Service, refer to Assign a Public URL to the AvePoint Cloud Index Gateway Service.

    • Passphrase – Specify a passphrase that will be used to gain access to the gateway service.

    *Note: The gateway service URL and passphrase will be further used when you configure Gateway Settings in AvePoint Online Services > AvePoint Cloud Index in order to connect the on-premises environment to the AvePoint Cloud Index instance in the cloud.

  10. The installation summary displays all previous configurations. Click Install to proceed with the installation, or click Back to change any of the previous settings. Click Cancel to abandon all configurations and exit the installation wizard.

  11. The installation process is displayed on the progress bar on the Installing page.

  12. Once the installation is complete, you can click Finish to complete the installation and exit the wizard.