Date: Wed, 10 Apr 2024 16:09:00 -0500 (CDT) Message-ID: <311772531.12364.1712783340682@PUBEDFIPRDWEB5.public.local> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_12363_364281176.1712783340681" ------=_Part_12363_364281176.1712783340681 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
This section describes how to set up the Ed-Fi ODS / API v5.2 in shared = instance mode. Before you proceed, make sure you have installed the prerequ= isites listed in Getting Started - Binary Installation.
The Ed-Fi ODS / API installation packages can be downloaded from the fol= lowing links:
The required release packages to install the Ed-Fi ODS / API can be foun= d at the links below. We recommend you stay current with the late= st patch update that has been promoted to release.
For each of the downloads, right-cl=
ick and select "Properties." Update the file extension (from .nupk=
g to .zip). Remove the version number (optional). Check the box next to
You may need to configure TLS while running =
the installation scripts described in steps below. Extract the contents of the EdFi.Suite3.RestApi.Databases package. =
The paths in these instructions assume that the package was extracted to a =
folder with the name of the package (e.g., C:\temp\EdFi.Suite3.RestApi.Data=
bases). There are several settings in the configuration file that are left empty=
as they depend on whether you are opting of SQL Server or PostgreSQL backe=
nd. Update the settings by consulting the samples provided below. SQL Server PostgreSQL Open a PowerShell window in Administrator m=
ode and navigate to the EdFi.Suite3.RestApi.Databases package folder. Run the following PowerShell command to loa=
d modules for installation: Next, execute the following command in Powe=
rShell: Extract the contents of the EdFi.Suite3.Installer.WebApi package. The pa=
ths in these instructions assume that the package was extracted to a folder=
with the name of the package (e.g., C:\temp\EdFi.Suite3.Installer.WebApi).=
Open a PowerShell window in Administrator m=
ode and navigate to the EdFi.Suite3.Installer.WebApi package folder. Run th=
e following Powershell command to load modules for installation: The WebApi installer can take a number of p=
arameters to tailor the installation experience (more examples can be found=
in the Install-EdFiOdsWebApi.psm1 file). At a minimum, database connection=
info is required. Copy and modify the following parameter cod=
e to fit your connection information: SQL Server PostgreSQL Paste the modified parameter code into your=
PowerShell window and hit Enter. Run the following command in the PowerShell window: Extract the contents of the "EdFi.Suite3.Installer.SwaggerUI" package. T=
he paths in these instructions assume that the package was extracted to a f=
older with the name of the package (e.g., C:\temp\EdFi.Suite3.Installer.Swa=
ggerUI). Open a PowerShell window in Administrator m=
ode and navigate to the "EdFi.Suite3.Installer.SwaggerUI" folder. Run the f=
ollowing Powershell command to load modules for installation: The Swagger UI installer can take a number =
of parameters to tailor the install experience (more examples can be found =
in the Install-EdFiOdsWebApi.psm1 file). At a minimum, WebAPI connecti=
on information is required. Copy and modify the following parameter cod=
e to add your site name: Paste the modified parameter into your Powe=
rShell window and execute the code. Run the following command in the PowerShell window: The Admin App provides a graphical interface for platform hosts to admin=
ister and manage non-sandbox instances of the Ed-Fi ODS / API. Follow the i=
nstallation steps here. Alternatively, API keys and secrets can be administered by=
database administrators via SQL queries as outlined in the article&nb=
sp;How To: Configure K=
ey / Secret. Just a fe=
w more tasks to complete your installation:
You are now ready to use the Ed-Fi ODS / API. The following URLs are ava=
ilable:[Net.ServicePointManager]::Security=
Protocol +=3D [Net.SecurityProtocolType]::Tls12
S=
tep 2. Install the Ed-Fi Databases
Ed=
it the configuration.json File
"Connec=
tionStrings": {
"EdFi_Ods": "server=3D(local);trusted_connection=3DTrue;database=3DEdF=
i_{0};Application Name=3DEdFi.Ods.WebApi",
"EdFi_Security": "server=3D(local);trusted_connection=3DTrue;database=
=3DEdFi_Security;persist security info=3DTrue;Application Name=3DEdFi.Ods.W=
ebApi",
"EdFi_Admin": "server=3D(local);trusted_connection=3DTrue;database=3DE=
dFi_Admin;Application Name=3DEdFi.Ods.WebApi",
"EdFi_Master": "server=3D(local);trusted_connection=3DTrue;database=3D=
master;Application Name=3DEdFi.Ods.WebApi"
},
"ApiSettings": {
"Mode": "SharedInstance",
"Engine": "SQLServer",
"MinimalTemplateScript": "EdFiMinimalTemplate",
"PopulatedTemplateScript": "GrandBend",
...
}
"Connec=
tionStrings": {
"EdFi_Ods": "host=3Dlocalhost;port=3D5432;username=3Dpostgres;database=
=3DEdFi_{0};Application Name=3DEdFi.Ods.WebApi",
"EdFi_Security": "host=3Dlocalhost;port=3D5432;username=3Dpostgres;dat=
abase=3DEdFi_Security;Application Name=3DEdFi.Ods.WebApi",
"EdFi_Admin": "host=3Dlocalhost;port=3D5432;username=3Dpostgres;databa=
se=3DEdFi_Admin;Application Name=3DEdFi.Ods.WebApi",
"EdFi_Master": "host=3Dlocalhost;port=3D5432;username=3Dpostgres;datab=
ase=3Dpostgres;Application Name=3DEdFi.Ods.WebApi"
},
"ApiSettings": {
"Mode": "SharedInstance",
"Engine": "PostgreSQL",
"MinimalTemplateScript": "PostgreSQLMinimalTemplate",
"PopulatedTemplateScript": "PostgreSQLPopulatedTemplate",
...
}
Run Installation Script
Impor=
t-Module .\Deployment.psm1
Initi=
alize-DeploymentEnvironment
Step 3. Inst=
all WebApi
Prepare Installation script
Impor=
t-Module .\Install-EdFiOdsWebApi.psm1
$=
parameters =3D @{
PackageVersion =3D "5.2.14406"
DbConnectionInfo =3D @{
Engine=3D"SqlServer"
Server=3D"localhost"
UseIntegratedSecurity=3D$true
}
InstallType =3D "SharedInstance" =20
}
$=
parameters =3D @{
PackageVersion =3D "5.2.14406"
DbConnectionInfo =3D @{=20
Engine=3D"PostgreSQL"=20
Server=3D"localhost"=20
Username=3D"postgres"
}
InstallType =3D "SharedInstance" =20
}
Run the Installation Script
Insta=
ll-EdFiOdsWebApi @parameters
Step 4. Ins=
tall Swagger
Prepare Installation Script
Impor=
t-Module .\Install-EdFiOdsSwaggerUI.psm1
$para=
meters =3D @{
PackageVersion =3D "5.2.14406"
WebApiVersionUrl =3D "https://YOUR_SITE_OR_SERVER_NAME_HERE/WebApi"
}
Run the Installation Script
Insta=
ll-EdFiOdsSwaggerUI @parameters
Step 5. In=
stall Admin App
Step 6.=
Restart your Website
Website
URL
Ed-Fi ODS / API
https://Y=
OUR_SERVER_NAME_HERE/WebApi/
Ed-Fi Admin App
https://YOUR_SERVER_NAME_HERE/AdminApp/
Ed-Fi ODS / API Documentation
https:/=
/YOUR_SERVER_NAME_HERE/SwaggerUI
Find out more about how to begin using the Ed-Fi ODS / <= /span>API: