# Elentra Platform Technical Documentation

## Elentra Platform Technical Documentation

- [Introduction](https://docs.elentra.org/technical/readme.md)
- [Reporting Issues](https://docs.elentra.org/technical/reporting-issues.md)
- [Server Requirements](https://docs.elentra.org/technical/administrators/server-requirements.md)
- [Application Server](https://docs.elentra.org/technical/administrators/application-server.md)
- [Shibboleth Single Sign-on](https://docs.elentra.org/technical/administrators/application-server/shibboleth-single-sign-on.md): The following guide/documentation can be used as a reference to install and configure Shibboleth SP v3 on Red Hat Enterprise Linux or CentOS 7.
- [Installing Supervisor](https://docs.elentra.org/technical/administrators/application-server/installing-supervisor.md)
- [Branded API Setup](https://docs.elentra.org/technical/administrators/application-server/branded-api-setup.md)
- [Installing Mailhog](https://docs.elentra.org/technical/administrators/application-server/installing-mailhog.md)
- [Database Server](https://docs.elentra.org/technical/administrators/database-server.md)
- [Getting Started](https://docs.elentra.org/technical/developers/getting-started.md)
- [Overview](https://docs.elentra.org/technical/developers/overview.md)
- [Contributions](https://docs.elentra.org/technical/developers/contributions.md): This guide will help technical leadership and staff understand how contributions to the Elentra Platform can be made by your institution.
- [Request for Change](https://docs.elentra.org/technical/developers/contributions/request-for-change.md)
- [Jira and GitHub Details](https://docs.elentra.org/technical/developers/contributions/jira-and-github-details.md)
- [Coding Standards](https://docs.elentra.org/technical/developers/contributions/coding-standards.md)
- [Quickstart Guide](https://docs.elentra.org/technical/developers/contributions/quickstart-guide.md)
- [Code Review](https://docs.elentra.org/technical/developers/contributions/code-review.md)
- [Database](https://docs.elentra.org/technical/developers/database.md)
- [Dataviews for Analytics](https://docs.elentra.org/technical/developers/dataviews-for-analytics.md)
- [Global Namespace](https://docs.elentra.org/technical/developers/global-namespace.md)
- [Elentra ACL](https://docs.elentra.org/technical/developers/elentra-acl.md)
- [Authentication Methods](https://docs.elentra.org/technical/developers/authentication-methods.md)
- [Compatibility Matrix](https://docs.elentra.org/technical/developers/compatibility-matrix.md): This compatibility matrix provides a description of what API version goes with each product release.
- [Elentra ME Versions](https://docs.elentra.org/technical/developers/elentra-me-versions.md)
- [Elentra Settings](https://docs.elentra.org/technical/developers/elentra-settings.md)
- [Elentra Deployment](https://docs.elentra.org/technical/developers/elentra-deployment.md): Elentra Deployment Tool v2.0.0
- [Feature Configuration](https://docs.elentra.org/technical/developers/feature-configuration.md)
- [Event Resource Integration](https://docs.elentra.org/technical/developers/feature-configuration/event-resource-integration.md)
- [Microsoft Teams Integration](https://docs.elentra.org/technical/developers/feature-configuration/microsoft-teams-integration.md)
- [Troubleshooting & Guides](https://docs.elentra.org/technical/developers/troubleshooting.md)
- [New developer features in Elentra ME 1.22](https://docs.elentra.org/technical/developers/troubleshooting/elentra-me-1.22.md): Highlights from the release
- [Testing With Codeception](https://docs.elentra.org/technical/developers/troubleshooting/testing-with-codeception.md)
- [Unit Testing](https://docs.elentra.org/technical/developers/troubleshooting/testing-with-codeception/unit-testing.md)
- [Unit Testing Best Practises](https://docs.elentra.org/technical/developers/troubleshooting/testing-with-codeception/unit-testing/unit-testing-best-practises.md)
- [Writing Unit Testable Code](https://docs.elentra.org/technical/developers/troubleshooting/testing-with-codeception/unit-testing/writing-unit-testable-code.md)
- [PHPUnit Testing for API](https://docs.elentra.org/technical/developers/troubleshooting/testing-with-codeception/unit-testing/phpunit-testing-for-api.md)
- [PHPUnit Json String Compare Function](https://docs.elentra.org/technical/developers/troubleshooting/testing-with-codeception/unit-testing/phpunit-json-string-compare-function.md)
- [Functional Testing](https://docs.elentra.org/technical/developers/troubleshooting/testing-with-codeception/functional-testing.md)
- [Functional Testing Best Practices](https://docs.elentra.org/technical/developers/troubleshooting/testing-with-codeception/functional-testing/functional-testing-best-practices.md)
- [Integration Testing](https://docs.elentra.org/technical/developers/troubleshooting/testing-with-codeception/integration-testing.md)
- [Integration Testing Best Practices](https://docs.elentra.org/technical/developers/troubleshooting/testing-with-codeception/integration-testing/integration-testing-best-practices.md)
- [Upgrading elentra-developer Docker](https://docs.elentra.org/technical/developers/troubleshooting/upgrading-elentra-developer-docker.md)
- [VS Code Setup](https://docs.elentra.org/technical/developers/troubleshooting/vscode-setup.md)
- [Using XDebug in VSCode](https://docs.elentra.org/technical/developers/troubleshooting/using-xdebug-in-vscode.md)
- [Upgrading PHP](https://docs.elentra.org/technical/developers/troubleshooting/upgrading-php.md)
- [Switching Databases](https://docs.elentra.org/technical/developers/troubleshooting/switching-databases.md)
- [Creating a new virtual host](https://docs.elentra.org/technical/developers/troubleshooting/creating-a-new-virtual-host.md): This page describes how to create a new Elentra vhost instance locally, in order to avoid switching versions in the same vhost (and the mayhem that typically ensues)
- [Logging In](https://docs.elentra.org/technical/developers/troubleshooting/logging-in.md)
- [Composer](https://docs.elentra.org/technical/developers/troubleshooting/composer.md)
- [Curriculum Tag Selector](https://docs.elentra.org/technical/developers/troubleshooting/curriculum-tag-selector.md)
- [Performance Issues](https://docs.elentra.org/technical/developers/troubleshooting/performance-issues.md)
- [Docker](https://docs.elentra.org/technical/developers/troubleshooting/docker.md)
- [Seed Data Generation](https://docs.elentra.org/technical/developers/troubleshooting/seed-data-generation.md)
- [Fail Fast Programming](https://docs.elentra.org/technical/developers/troubleshooting/fail-fast-programming.md): Advanced Programming Practises To Reduce Bugs
- [Advanced Custom Exception Classes](https://docs.elentra.org/technical/developers/troubleshooting/advanced-custom-exception-classes.md): Advanced exception classes for fast-fail programming
- [Support](https://docs.elentra.org/technical/developers/support.md)
- [Upgrading to ME v28.0](https://docs.elentra.org/technical/upgrade-guides/upgrading-to-me-v28.0.md): Upgrading Guide for the release for v28.0
- [Upgrading to ME 1.27](https://docs.elentra.org/technical/upgrade-guides/upgrading-to-me-1.27.md): Elentra ME 1.27 was released on March 5th, 2024.
- [Upgrading to ME 1.26](https://docs.elentra.org/technical/upgrade-guides/upgrading-to-me-1.26.md): Elentra ME 1.26 was released on April 4th, 2023.
- [Upgrading to ME 1.25](https://docs.elentra.org/technical/upgrade-guides/upgrading-to-me-1.25.md): Elentra ME 1.25 was released on April 4th, 2023.
- [Upgrading to ME 1.24](https://docs.elentra.org/technical/upgrade-guides/upgrading-to-me-1.24.md): Elentra ME 1.24 was released on September 16th, 2022.
- [Upgrading to ME 1.23](https://docs.elentra.org/technical/upgrade-guides/upgrading-to-me-1.23-1.md)
- [Upgrading to ME 1.22](https://docs.elentra.org/technical/upgrade-guides/upgrading-to-me-1.22.md)
- [Upgrading to ME 1.21](https://docs.elentra.org/technical/upgrade-guides/upgrading-to-me-1.21.md)
- [Upgrading to ME 1.20](https://docs.elentra.org/technical/upgrade-guides/upgrading-to-me-1.20.md)
- [Upgrading to ME 1.19](https://docs.elentra.org/technical/upgrade-guides/upgrading-to-me-1.19.md)
- [Upgrading to ME 1.18](https://docs.elentra.org/technical/upgrade-guides/upgrading-to-me-1.18.md): Elentra ME 1.18 was released on May 12th, 2020
- [Upgrading to ME 1.17](https://docs.elentra.org/technical/upgrade-guides/upgrading-to-me-1.17.md): Elentra ME 1.17 was released on December 20th, 2019.
- [Upgrading to ME 1.16](https://docs.elentra.org/technical/upgrade-guides/upgrading-to-me-1.16.md)
- [Upgrading to ME 1.15](https://docs.elentra.org/technical/upgrade-guides/upgrading-to-me-1.15.md): Upgrade instructions for upgrading from Elentra ME 1.13 or 1.14 to version 1.15.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.elentra.org/technical/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
