Skip to main content

HERCULES SGI Documentation

Learn how to deploy, configure, and use the comprehensive Research Management System designed for Spanish universities

Quick Start

Get HERCULES SGI up and running in your institution

1

Review System Requirements

Check the prerequisites for deploying HERCULES SGI, including Java 11+, PostgreSQL, and Keycloak authentication server.See the Installation Guide for detailed requirements.
2

Deploy Backend Services

Deploy the microservices architecture using Docker containers or build from source with Maven.
# Clone the repository
git clone https://github.com/herculesproject/sgi.git
cd sgi

# Build all services
mvn clean install
Each service runs independently and communicates via REST APIs.
3

Configure Authentication

Set up Keycloak with the SGI realm configuration to enable user authentication and role-based access control.Import the provided realm configuration from sgi-auth/realm/sgi-realm.json.Learn more in the Authentication Guide.
4

Access the Web Interface

Navigate to the SGI web application and log in with your configured credentials to start managing research activities.Explore the User Guides for role-specific workflows.

Core Modules

Explore the key modules that power research management

CSP Module

Manage grant calls, applications, and research projects throughout their lifecycle

ETI Module

Handle ethics reviews, committee management, and evaluation workflows

PII Module

Track inventions and manage intellectual property protection requests

PRC Module

Monitor and analyze scientific production and research output

EER Module

Manage relationships with external research entities and partners

Reporting

Generate comprehensive reports across all research activities

User Guides

Role-based guides for different system users

Researcher Guide

Learn how to submit applications, manage projects, and track your research activities

Administrator Guide

Configure the system, manage users, and maintain institutional settings

Manager Guide

Oversee research operations, approve requests, and generate institutional reports

API Reference

Integrate with HERCULES SGI through REST APIs

Service APIs

Explore the REST endpoints for all backend microservices

Authentication

Learn how to authenticate and authorize API requests using Keycloak

Ready to Deploy?

Follow our comprehensive deployment guide to set up HERCULES SGI in your institution

View Installation Guide

Build docs developers (and LLMs) love