Technical documentation

For technical users and developers

This section provides technical documentation for:

• IT staff/System administrators: Quick installation and deployment
• Developers: Customizing, extending, and contributing to EvoNEST

Non-technical user? See the Workshop tutorial for a beginner-friendly installation guide.

Welcome to the EvoNEST technical documentation. This section covers installation, deployment, customization, and development.

Installation & Deployment

Get EvoNEST running quickly with our technical installation guide:

• Quick Installation – Docker-based installation for technical users
• Connecting to Virtual Machines via SSH – General guide for accessing institutional VMs (not EvoNEST-specific)

After installation: See the User documentation to configure your NEST and add users.

Authentication setup

Setting up secure authentication is essential for production deployments:

• Google OAuth Setup – Easy setup with Google authentication for users with Google accounts
• EU-Compliant Authentication (Keycloak) – Self-hosted, GDPR-compliant authentication with full data sovereignty

Choose Google OAuth for quick setup, or Keycloak for maximum control and EU compliance.

Customization & extension

Extend EvoNEST functionality to match your laboratory's specific needs:

• Sample Cards Development – Create modular cards for sample detail pages
• Data Format Parser Development – Build custom parsers for machine-readable files
• File Processor Development – Add support for new file formats and data types

Additional resources

• API Documentation – Complete REST API reference
• Contributing Guidelines – How to contribute to EvoNEST
• GitHub Repository – Report issues and contribute code

Getting help

Need assistance?

• Installation issues: Check the troubleshooting guide
• Development questions: Open an issue on GitHub
• General usage: See the User documentation