shieldauth/shield repository overview

⁠Shield: An Advanced IAM and CIAM Solution

Not ready for production use yet. Please use with caution.

Shield is a robust, multi-tenant authentication and authorization solution developed by Mukesh Singh⁠ for modern age applications. It provides a comprehensive set of features to secure your applications and manage user access effectively.

⁠Key Features

• Multi-tenant Support: Manage multiple organizations or projects within a single instance.

• User Management: Efficiently handle user accounts and permissions.

• Role-based Access Control (RBAC): Define and manage user roles and permissions.

• Session Management: Secure handling of user sessions.

• API Key Support: Generate and manage API keys for secure programmatic access.

  • API Key Rotation
  • Rate Limiting
  • Expiration
  • Blacklisting and Whitelisting
  • Revocation

⁠Getting Started

⁠Prerequisites

Before you begin, ensure you have the following installed:

• Docker⁠
• Docker Compose⁠

⁠Installation

⁠1. Clone the repository

git clone https://github.com/shield-auth/shield.git
cd shield

⁠2. Set Up Environment Variables

cp .env.example .env

⁠3. Build and Start the Containers

docker compose up -d --build --wait

⁠4. Retrieve Default credentials

The default credentials are saved in `/usr/local/bin/logs/default_cred.json. To view them:

docker exec shield-shield-1 cat /usr/local/bin/logs/default_cred.json

Note: If the above command doesn't work, use docker ps to find the correct container ID for the shield container.