A newer version of the Ed-Fi ODS / API is now available. See the Ed-Fi Technology Version Index for a link to the latest version.

Skip to end of metadata
Go to start of metadata

This section describes how to set up the Ed-Fi ODS / API v5.2 using the release binaries listed in Binary Releases. This is recommend approach for implementations that have no requirement to extend or customize the source code of the Ed-Fi ODS / API.

Before binary installation, install the prerequisites listed in the following steps: 

Detail on each step follows.

Step 1. Install and Configure Windows Components

Database Server

Ensure that the following components are installed:

  • PowerShell 5.0. PowerShell is used by the database deployment scripts.

  • .NET Core 3.1 Runtime. Required by the Database Deploy Tool used in the database deployment scripts.

    PowerShell 5.0

    Verify that PowerShell 5.0 or above is installed:

    1. Press the Windows key Windows logo on your keyboard, type PowerShell, select Windows PowerShell, and press Enter.

    2. Type $PSVersionTable.PSVersion, and press Enter

    3. If the required version is not installed, download Windows Management Framework 5.0, which includes PowerShell 5.0.


    .NET Core 3.1 Runtime

    Download and install .NET Core 3.1 Runtime.

Web Server 

Ensure that the following components are installed:

  • Internet Information Services. IIS is the web server that will run the ODS / API.

  • .NET Core 3.1 Hosting Bundle. The .NET Core 3.1 Hosting Bundle is required for running the API on IIS. Required to be installed after IIS.

    Internet Information Services

    1. Press the Windows key Windows logo on your keyboard, type "features", select Turn Windows features on or off, press Enter.

    2. Check the box next to Internet Information Services. The default selections will be good for most cases. 

    3. Click OK.


    .NET Core 3.1 Hosting Bundle

    Download and install .NET Core Hosting Bundle 3.1.

Step 2. Install and Configure Required Software

Ensure that the following software is installed and configured on the database server:

  • Microsoft SQL Server 2016 or 2017. Microsoft SQL Server is used to store the data for the Ed-Fi ODS / API. Standard, Developer, or Enterprise Editions with Service Pack 2 or higher are supported. 
  • Alternative PostgreSQL datastore: PostgreSQL 11.x. PostgreSQL can be used as the datastore for and Ed-Fi ODS / API instance instead of Microsoft SQL Server.

Step 3. Install and Configure ODS / API 

PowerShell installers released with the ODS / API provide varied configuration options. The primary ODS / API install use cases are provided as examples below. Choose the option that suites your need and customize parameters as needed.

You may need to change the execution policy for unsigned PowerShell scripts to run on your machine to run the scripts. This can be done by opening a PowerShell console and typing the following command:

Set-ExecutionPolicy Unrestricted



Contents

Find out more about how to begin using the Ed-Fi ODS / API:

  • No labels