Technical Documentation

Who is this for?

Sunbird ED's developer documentation is meant for its adopters, developers and contributors.

The developer documentation helps you to get familiar with the bare necessities, giving you a quick and clean approach to get you up and running. 

Sunbird is an open-source platform, you are free to use any programming language to extend or customize it. To try the Sunbird APIs, a basic understanding of REST APIs and a knowledge of object-oriented design principles is a plus, though not necessary.

The Developer documentation provides you with a complete set of guidelines which you need to:

  • Install Sunbird ED
  • Configure Sunbird ED
  • Customize Sunbird ED
  • Extend Sunbird ED
  • Contribute to Sunbird ED

How to instantiate Sunbird ED?

Installing the full version of Sunbird ED has the following prerequisites : 

  • System administrator permissions on Sunbird and all servers
  • Hands-on experience in administering and debugging Linux systems
  • Hands-on experience using Docker and Kubernetes to run containerized services