Getting Started
This documentation covers how to deploy and configure Ed-Fi API v8, which comprises two services:
- Ed-Fi API — the Ed-Fi REST API for reading and writing education data
- Configuration Service — the management API for administering vendors, applications, claim sets, and data stores
Ed-Fi API v8 is deployed using Docker. Docker Compose is the supported deployment method for both local development and production environments.
Audience
This documentation is for technical professionals who deploy and operate Ed-Fi API platforms, including system administrators, DevOps engineers, and developers evaluating or implementing Ed-Fi API v8.
Prerequisites
| Requirement | Minimum Version | Notes |
|---|---|---|
| Docker Desktop or Podman Desktop | Latest stable | Docker Compose v2 required |
| PowerShell | 7.0 | Cross-platform; required to run the provided startup scripts |
| Git | Any | For cloning the source repository |
These instructions use the startup scripts provided in the Ed-Fi API source
repository. The scripts orchestrate Docker Compose, database provisioning,
and initial configuration in the correct order. Running docker compose up
directly is not recommended for first-time setup.
Tested Configurations
Ed-Fi API v8 has been tested with the following configurations:
- Ubuntu 22.04 / macOS 14 / Windows 11
- Docker Desktop 4.x with Docker Compose v2
- PostgreSQL 16 (bundled in the provided Docker Compose files)
- SQL Server 2022 (optional; see Getting Started — Appendix)
Steps Overview
- Docker Deployment — start the Ed-Fi API and Configuration Service using Docker Compose
- Configure a Data Store — create the initial client credentials and data store via the Configuration Service