Skip to content

Ouranosinc/Magpie

Repository files navigation

Magpie: A RestFul AuthN/AuthZ service

Magpie (the smart-bird)
a very smart bird who knows everything about you.

Magpie is service for AuthN/AuthZ accessible via a REST API implemented with the Pyramid web framework. It allows you to manage User/Group/Service/Resource/Permission with a PostgreSQL database. Behind the scene, it uses Ziggurat-Foundations and Authomatic.

dependencies
tests status
Github Actions CI Build Status (master branch) Github Actions CI Build Status (latest tag) Travis-CI CodeCov Coverage Codacy Badge
docker status
Docker Build Status (latest tag) Docker Build Status (latest tag) Docker Latest Tag Docker Version Tag
releases
Python Versions Description
Legacy Older versions could still work, but maintenance is dropped.
Supported Tested by the CI and maintained for backward compatibility.
Recommended Prefered minimal version to use for latest security updates and performance enhancements.

Documentation

The REST API documentation is auto-generated and served under {MAGPIE_URL}/api/ using Swagger-UI with tag latest.

More ample details about installation, configuration and usage are provided on ReadTheDocs.
These are generated from corresponding information provided in docs directory.

Configuration and Usage

Multiple configuration options exist for Magpie application.
Please refer to Configuration section for details.
See Usage section for details.

Change History

Addressed features, changes and bug fixes per version tag are available in CHANGES.

Docker Images

Following most recent variants are available:

Magpie Twitcher
(with integrated MagpieAdapter)
pavics/magpie:4.1.0 pavics/twitcher:magpie-4.1.0
pavics/magpie:latest pavics/twitcher:magpie-latest

Notes:

  • Older tags the are also available: Magpie Docker Images
  • Twitcher image with integrated MagpieAdapter are only available for Magpie >=1.0.0