Page Comparison

Required Configuration Settings

Some configuration must be done for every Ed-Fi ODS / API platform instance. Examples of required configurations include database connection strings, SMTP server locations, and similar.

To make it easier for developers to install and run the Ed-Fi ODS / API, the default download from source control is pre-configured with values appropriate for a developer or single-server test instance of the system. 

Application	Location	Setting Name	Value	Description
EdFi.Ods.SandboxAdmin	appsettings.json	OAuthUrl	Example: http://site-address:port/oauth	Points to the root of the authorization API in the Ed-Fi ODS / API.
EdFi.Ods.WebApi	appsettings.json	ApiSettings:Mode	Example: Sandbox, SharedInstance, YearSpecific, DistrictSpecific	The component settings for the API. See the following section on Developers' Guide for more information on this setting.
EdFi.Ods.SwaggerUI	appsettings.json	WebApiVersionUrl	Example: http://site-address:port/	Points to the version endpoint in the Ed-Fi ODS / API.

A deployment to a staging or production instance is usually more involved, and requires additional configuration. Required configurations for a production instance can be found in the Deployment section of this documentation.

Optional Configuration Settings

"Years": [
    {
      "Year": "2020"
    },
    {
      "Year": "2021",
      "IsDefault": true
    },
    {
      "Year": "2022"
    }
  ],

Contents on appsettings.json
 "User": {
        "Test Admin": {
            "Email": "test@ed-fi.org",
            "Admin": "true",
            "NamespacePrefixes": [
                "uri://ed-fi.org",
                "uri://gbisd.org"
            ],
            "Password": "zSKj8DdR4mQlPp3X2i1ra",
            "Sandboxes": {
                "Minimal Demonstration Sandbox": {
                    "Key": "FLqUvMPSoG4ryp7HiRBmX",
                    "Type": "Minimal",
                    "Secret": "bhJfA6qt7iNP3Xd5as9O0",
                    "Refresh": "false"
                },
                "Populated Demonstration Sandbox": {
                    "Key": "rcKsguTICAaBm9PxyUW4i",
                    "Type": "Sample",
                    "Secret": "t0CklTOfMBGZNPgVQDLHh",
                    "Refresh": "false"
                }
            }
        }
    }

Environment

Configuration 

Secret Manager 

In development environments ASP.NET Core applications in the ODS / API solution uses secret manager tool to provide a way for setting overrides away from the projects so that they aren't accidentally checked into source control. To set overrides, you can either use the .NET CLI Tool 

or Manage User Secrets gesture in Visual Studio. 

Both of the above methods will create a secret.json file in the local machine's user profile folder and will override settings in appsettings.Development.json.

e.g., Following secret.json overrides the default 'GrandBend' dataset and deploys with 'Glendale' sample dataset.

See Safe storage of app secrets in development in ASP.NET Core for more details.