# Melody Auth

**Melody Auth** is a user-friendly, robust solution for implementing and hosting your own OAuth and authentication system.
- Deploy to **Cloudflare** using **Workers, D1, and KV** in just minutes — minimizing infrastructure and DevOps overhead.
- **Self-Host** with **Node.js, Redis, and PostgreSQL** — giving you full control over your data and infrastructure.

[![codecov](https://codecov.io/gh/ValueMelody/melody-auth/graph/badge.svg?token=AB3C1DCJJM)](https://codecov.io/gh/ValueMelody/melody-auth)

[Feature Overview](docs/feature-overview.md)

**Disclaimer** All French translations provided in this project have been generated by AI. Please review them carefully for accuracy before use.

## What's included?
- **OAuth & Authentication Server** [[Setup]](https://auth.valuemelody.com/auth-server-setup.html) [[Config]](https://auth.valuemelody.com/auth-server-configuration.html)
- **Server-to-Server REST API** for backend integrations [[Setup]](https://auth.valuemelody.com/s2s-api.html) [[Swagger]](https://auth-server.valuemelody.com/api/v1/swagger)
- **Admin Panel** for managing resources (also serves as a full-stack implementation example) [[Setup]](https://auth.valuemelody.com/admin-panel-setup.html)
- **React/Angular/Vue/Web SDK** to seamlessly integrate PKCE-based authentication into your frontend application.
  - react-sdk [[Package]](https://www.npmjs.com/package/@melody-auth/react) [[Doc]](https://auth.valuemelody.com/react-sdk.html)
  - angular-sdk [[Package]](https://www.npmjs.com/package/@melody-auth/angular) [[Doc]](https://auth.valuemelody.com/angular-sdk.html)
  - vue-sdk [[Package]](https://www.npmjs.com/package/@melody-auth/vue) [[Doc]](https://auth.valuemelody.com/vue-sdk.html)
  - web-sdk [[Package]](https://www.npmjs.com/package/@melody-auth/web) [[Doc]](https://auth.valuemelody.com/web-sdk.html)
- **Embedded Auth API** for embedding authentication flows directly within your application. [[Setup]](https://auth.valuemelody.com/embedded-auth-api.html) [[Swagger]](https://auth-server.valuemelody.com/api/v1/embedded-swagger)

## Auth Server Features Supported
- <b>OAuth 2.0</b>:
  - Authorize
  - Token Exchange
  - Refresh Token Revoke
  - App Consent
  - App Scopes
  - User Info Retrieval
  - OpenID Configuration
- <b>[Authorization](https://auth.valuemelody.com/authentication.html)</b>:
  - Sign-In
  - Passwordless Sign-In
  - Sign-Up
  - Sign-Out
  - Email Verification
  - Password Reset
  - [Role-Based Access Control](https://auth.valuemelody.com/rbac.html)
  - [User Attribute](https://auth.valuemelody.com/user-attributes.html)
  - Account Linking
  - [Localization](https://auth.valuemelody.com/localization.html)
- <b>External Identity Providers</b>:
  - [Social Sign-In](https://auth.valuemelody.com/social-sign-in-provider-setup.html)
    - Google Sign-In
    - Facebook Sign-In
    - GitHub Sign-In
    - Discord Sign-In
    - Apple Sign-In
  - [OIDC Auth Provider Sign-In](https://auth.valuemelody.com/oidc-sso-setup.html)
  - [SAML SSO Sign-In (Node.js environment only)](https://auth.valuemelody.com/saml-sso-setup.html)
- <b>[Multi-Factor Authentication](https://auth.valuemelody.com/mfa-setup.html)</b>
  - Email MFA
  - OTP MFA
  - SMS MFA
  - MFA Self Enrollment
  - Passkey Enrollment
  - Recovery Code
  - Remember Device for 30 days
- <b>[Policy](https://auth.valuemelody.com/policies.html)</b>
  - sign_in_or_sign_up
  - update_info
  - change_password
  - change_email
  - reset_mfa
  - manage_passkey
  - manage_recovery_code
  - [saml_sso_[idp_name]](https://auth.valuemelody.com/saml-sso-setup.html#_trigger-login-via-saml-sso-in-the-frontend)
  - [oidc_sso_[provider_name]](https://auth.valuemelody.com/oidc-sso-setup.html#_trigger-oidc-redirects-from-your-frontend-via-policy)
- <b>Organization</b>:
  - [Branding config override](https://auth.valuemelody.com/branding.html#per-organization-branding)
  - [Organization users](https://auth.valuemelody.com/organizations.html)
  - [Organization groups](https://auth.valuemelody.com/org-groups.html)
- <b>[Mailer Option](https://auth.valuemelody.com/email-provider-setup.html)</b>
  - SendGrid
  - Mailgun
  - Brevo
  - Resend
  - Postmark
  - SMTP (Node.js environment only)
- <b>[SMS Option](https://auth.valuemelody.com/sms-provider-setup.html)</b>
  - Twilio
- <b>JWT Authentication</b>
  - [RSA256 based JWT Authentication](https://auth.valuemelody.com/jwt-and-jwks.html)
  - [JWT Secret Rotate](https://auth.valuemelody.com/jwt-secret-rotate.html)
- <b>Brute-force Protection</b>:
  - Log in attempts
  - Password reset attempts
  - OTP MFA attempts
  - SMS MFA attempts
  - Email MFA attempts
  - Change Email attempts
  - Email Verification attempts
- <b>Logging</b>:
  - Logger Level
  - Email Logs
  - SMS Logs
  - Sign-in Logs

## Admin Panel & S2S REST API Features Supported
- View Configurations
- Manage Users
  - [User Invite](https://auth.valuemelody.com/user-invite.html)
  - [Impersonation](https://auth.valuemelody.com/impersonation.html)
- Manage User Attributes
- Manage Apps
  - [App Level MFA Config](https://auth.valuemelody.com/mfa-setup.html#_app-level-mfa-configuration)
  - [App Banner Config](https://auth.valuemelody.com/app-banners.html)
- Manage Scopes
- Manage Roles
- Manage Organizations
- Manage SAML SSO IDPs
- [Manage Logs](https://auth.valuemelody.com/log-management.html)
- [Admin Panel Access Control](https://auth.valuemelody.com/admin-panel-setup.html#custom-role-access-for-the-admin-panel)

## Demo & Examples
- [Demo Site](https://auth-demo.valuemelody.com)
- [Vite React Example](https://github.com/ValueMelody/melody-auth-examples/tree/main/vite-react-demo)
- [Angular Example](https://github.com/ValueMelody/melody-auth-examples/tree/main/angular-example)
- [Vite Vue Example](https://github.com/ValueMelody/melody-auth-examples/tree/main/vite-vue-example)
- [Next.js Full stack implementation Example](https://github.com/ValueMelody/melody-auth/tree/main/admin-panel)
- [Next.js Auth.js Example](https://github.com/ValueMelody/melody-auth-examples/tree/main/next-auth-js-example)
- [React Native Example](https://github.com/ValueMelody/melody-auth-examples/tree/main/react-native-example)
- [Vanilla JavaScript Example](https://github.com/ValueMelody/melody-auth-examples/tree/main/vite-web-example)
- [Embedded Auth API Example](https://github.com/ValueMelody/melody-auth-examples/tree/main/embedded-auth)

## Screenshots
[Authorization Screenshots](https://auth.valuemelody.com/screenshots.html#identity-pages-and-emails)  
[Admin Panel Screenshots](https://auth.valuemelody.com/screenshots.html#admin-panel-pages)

## License

This project is licensed under the MIT License. See the LICENSE file for details.