Getting Started

Introduction

Welcome to FerrisKey documentation.

Welcome to FerrisKey, a modern Identity and Access Management (IAM) solution built with Rust for exceptional performance and security.

What is FerrisKey?

FerrisKey is a high-performance, secure IAM platform designed as a modern alternative to Keycloak. Written entirely in Rust, FerrisKey provides enterprise-grade identity and access management capabilities with superior performance, memory safety, and reliability. Whether you're securing microservices, web applications, or APIs, FerrisKey delivers the authentication and authorization features you need with the speed and safety that only Rust can provide.

Why FerrisKey over Keycloak?

Rust Performance

Built with Rust for blazing-fast performance, minimal memory usage, and zero-cost abstractions

Memory Safety

Rust's ownership model eliminates common security vulnerabilities like buffer overflows and memory leaks

Lightweight

Significantly lower resource consumption compared to Java-based solutions like Keycloak

Fast Startup

Near-instant startup times make it perfect for containerized and serverless environments

Key Features

FerrisKey provides comprehensive IAM capabilities with modern architecture:

  • πŸ” OAuth 2.0 & OpenID Connect: Full compliance with industry-standard authentication protocols
  • πŸ‘₯ User Management: Complete user lifecycle management with registration, profiles, and account management
  • 🎯 Role-Based Access Control (RBAC): Fine-grained permissions and role management
  • 🏒 Multi-Tenancy: Support for multiple organizations and realms in a single instance
  • πŸ”‘ Single Sign-On (SSO): Seamless authentication across multiple applications
  • πŸ“± Multi-Factor Authentication (MFA): Built-in support for TOTP, SMS, and hardware tokens
  • 🌐 Social Login: Integration with Google, GitHub, Facebook, and other OAuth providers
  • πŸ“Š Audit Logs: Comprehensive logging for security and compliance requirements
  • πŸš€ High Availability: Built for clustering and horizontal scaling
  • πŸ“‘ REST APIs: Full-featured APIs for integration and automation

Use Cases

FerrisKey is perfect for securing various types of applications:

  • Microservices Architecture: Secure service-to-service communication and API gateways
  • Web Applications: Add authentication and authorization to React, Vue, or any web framework
  • Mobile Apps: Secure mobile applications with OAuth 2.0 flows
  • Enterprise Applications: Replace legacy authentication systems with modern IAM
  • SaaS Platforms: Multi-tenant authentication for Software-as-a-Service applications
  • API Security: Protect REST APIs and GraphQL endpoints
  • Container Orchestration: Lightweight IAM for Kubernetes and Docker environments

Architecture

FerrisKey's modern architecture delivers exceptional performance:

  • Async-First: Built with Tokio for high-concurrency async operations
  • Cloud-Native: Designed for containerization and cloud deployment
  • Stateless Design: Horizontally scalable with external session storage
  • Modular: Plugin architecture for custom authentication flows and integrations
  • Secure by Design: Follows best practices for security and data protection
  • Hexagonal Architecture: Clear separation of concerns for maintainability and testability

Getting Started

Ready to replace Keycloak with FerrisKey? Start with our Installation Guide to deploy your first FerrisKey instance, or explore our Configuration section to learn about customizing FerrisKey for your specific requirements.

Whether you're migrating from Keycloak or building a new authentication system, FerrisKey provides the performance, security, and developer experience you need for modern applications.