Skip to content

georchestra/georchestra-gateway

Repository files navigation

geOrchestra Gateway

geOrchestra Logo

Modern, Secure, and Flexible Gateway for the geOrchestra SDI Platform

Build Status Documentation License

Overview

The geOrchestra Gateway is a Spring Cloud Gateway-based service that provides a secure, central entry point to all geOrchestra applications. It replaces the previous security-proxy component, offering enhanced flexibility, modern authentication methods, and improved performance.

Key Features

  • Multiple Authentication Methods

    • ✅ OAuth2 and OpenID Connect
    • ✅ LDAP Authentication
    • ✅ Header-based Pre-authentication
  • Modern Web Standards

    • ✅ HTTP/2 Support
    • ✅ WebSocket Support
    • ✅ Spring WebFlux Reactive Stack
  • Security

    • ✅ Role-Based Access Control
    • ✅ Flexible Header Management
    • ✅ Centralized Security Policies
  • Developer Experience

    • ✅ Comprehensive Documentation
    • ✅ Easy Configuration
    • ✅ Docker-Ready

Documentation

Visit our comprehensive documentation to learn more about installation, configuration, and development.

Quick Start

Using Docker Compose

The Gateway is available as part of the geOrchestra Docker Compose setup:

git clone https://github.com/georchestra/docker.git
cd docker
docker-compose up -d

Configuration

The Gateway provides flexible configuration options through YAML files:

georchestra:
  gateway:
    # Your configuration goes here
  security:
    ldap:
      enabled: true
      url: ldap://ldap:389
      # Additional LDAP configuration

For detailed configuration options, see the Configuration Guide.

Building from Source

Prerequisites

  • Java 21+
  • Maven 3.8+
  • Docker (optional, for building images)

Build Commands

Build with all tests:

make

Build and install without tests:

make install

Run tests:

make test

Build Docker image:

make docker

Build Debian package:

make deb

Documentation Development

To work on the documentation locally:

./setup_mkdocs.sh
./run_mkdocs.sh

Then visit http://127.0.0.1:8000 in your browser.

Contributing

We welcome contributions! Please see our Contributing Guide for details.

About geOrchestra

geOrchestra is a free, modular, and interoperable Spatial Data Infrastructure solution born in 2009 to meet the requirements of the INSPIRE European directive.

The project is governed by a Project Steering Committee (PSC) and follows the "made by people for people" philosophy, with a focus on community-driven development.

License

This project is licensed under GPL-3.0.