Skip to content

Commit 9166b2c

Browse files
Enhance README and documentation with updated features, improved descriptions, and additional badges for PyPI version and downloads
1 parent 12ae991 commit 9166b2c

File tree

5 files changed

+29
-10
lines changed

5 files changed

+29
-10
lines changed

README.md

+27-8
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,37 @@
11
# JANUX Authentication Gateway
22

33
[![Python](https://img.shields.io/badge/Python-3.10%2B-darkcyan)](https://pypi.org/project/janux-auth-gateway/)
4+
[![PyPI - Version](https://img.shields.io/pypi/v/janux-auth-gateway?label=PyPI%20Version&color=green)](https://pypi.org/project/janux-auth-gateway/)
5+
[![PyPI Downloads](https://static.pepy.tech/badge/janux-auth-gateway)](https://pepy.tech/projects/janux-auth-gateway)
46
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache2.0-orange.svg)](https://github.com/fox-techniques/janux-auth-gateway/blob/main/LICENSE)
57
[![GitHub](https://img.shields.io/badge/GitHub-janux--auth--gateway-181717?logo=github)](https://github.com/fox-techniques/janux-auth-gateway)
68

7-
The JANUX Authentication Gateway is a modular and extensible authentication microservice built using FastAPI. It supports user and admin authentication, JWT management, and MongoDB operations via Beanie ODM. This package is designed for developers seeking a robust and scalable authentication solution for their applications.
9+
**JANUX Authentication Gateway** is a high-performance, modular, and extensible authentication microservice built with **FastAPI**. It provides secure user and admin authentication, JWT management, and seamless MongoDB integration via Beanie ODM. Designed for developers and organizations, JANUX ensures scalability, flexibility, and security—making it ideal for **SaaS platforms, APIs, and enterprise applications** that require a robust authentication system.
810

9-
## Features
1011

11-
- Secure password hashing and verification using bcrypt.
12-
- JWT-based authentication for users and admins.
13-
- Modular API routing for user, admin, and authentication endpoints.
14-
- Centralized logging and error handling for better maintainability.
15-
- MongoDB integration using Beanie ODM.
16-
- Health check and root endpoint for monitoring.
12+
## 🌟 Key Features
13+
14+
- 🚀 **FastAPI-based** – Asynchronous, high-performance authentication.
15+
- 🔑 **JWT Authentication & Token Management** – Secure access and refresh tokens.
16+
- 🏷️ **Role-Based Access Control (RBAC)** – Admins, users, and fine-grained permissions.
17+
- 🗄️ **MongoDB with Beanie ODM** – Flexible user and admin management.
18+
- 🔐 **Secure Password Hashing** – Uses Argon2 & Bcrypt for industry-leading security.
19+
- 📜 **Cryptographic Key Support** – RSA, Ed25519, and ECDSA for secure key management.
20+
- 🔄 **Redis-Based Token Blacklisting** – Prevents reuse of revoked tokens.
21+
- 🌍 **CORS Middleware** – Configurable allowed origins for API security.
22+
- 🏗️ **Modular & Extensible** – Easily customizable for different authentication workflows.
23+
- 📦 **Deploy Anywhere** – Works in Docker, Kubernetes, and serverless environments.
24+
25+
26+
## 📌 Why Choose **JANUX**?
27+
28+
**JANUX** is developer-friendly, scalable, and production-ready. It eliminates the complexity of authentication by providing a plug-and-play solution for handling users, roles, security, and authentication tokens—so you can focus on building your core application.
29+
30+
## 💡 Use **JANUX** if you need:
31+
32+
- ✅ A ready-to-use authentication system **for APIs and SaaS apps**.
33+
- ✅ A secure and scalable solution with **RBAC & JWT**.
34+
- ✅ Flexibility to extend authentication workflows.
35+
- ✅ Modern authentication standards with **FastAPI, MongoDB, and Redis**.
1736

1837
---

docs/assets/janux-favicon.png

-49.5 KB
Loading

docs/assets/janux-flyer.png

-184 Bytes
Loading

docs/assets/janux-logo.png

47.2 KB
Loading

docs/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ title: JANUX Authentication Gateway
77
![JANUX Flyer](assets/janux-flyer.png){ width=200 }
88

99
[![Python](https://img.shields.io/badge/Python-3.10%2B-darkcyan)](https://pypi.org/project/janux-auth-gateway/)
10+
[![PyPI - Version](https://img.shields.io/pypi/v/janux-auth-gateway?label=PyPI%20Version&color=green)](https://pypi.org/project/janux-auth-gateway/)
11+
[![PyPI Downloads](https://static.pepy.tech/badge/janux-auth-gateway)](https://pepy.tech/projects/janux-auth-gateway)
1012
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache2.0-orange.svg)](https://github.com/fox-techniques/janux-auth-gateway/blob/main/LICENSE)
1113
[![GitHub](https://img.shields.io/badge/GitHub-janux--auth--gateway-181717?logo=github)](https://github.com/fox-techniques/janux-auth-gateway)
1214

13-
<!-- [![PyPI - Version](https://img.shields.io/pypi/v/janux-auth-gateway?label=PyPI%20Version&color=green)](https://pypi.org/project/janux-auth-gateway/)
14-
[![PyPI Downloads](https://static.pepy.tech/badge/janux-auth-gateway)](https://pepy.tech/projects/janux-auth-gateway) -->
1515

1616
**JANUX Authentication Gateway** is a high-performance, modular, and extensible authentication microservice built with **FastAPI**. It provides secure user and admin authentication, JWT management, and seamless MongoDB integration via Beanie ODM. Designed for developers and organizations, JANUX ensures scalability, flexibility, and security—making it ideal for **SaaS platforms, APIs, and enterprise applications** that require a robust authentication system.
1717

0 commit comments

Comments
 (0)