agileone/authorizer

An open source authentication and authorization system.Bring your database and have authentication microservice ready in few clicks

Authorizer

Authorizer is an open-source authentication and authorization solution for your applications. Bring your database and have complete control over the user information. You can self-host authorizer instances and connect to any SQL database.

Table of contents

• Introduction
• Getting Started
• Contributing
• Docs
• Join Community

Introduction

We offer the following functionality

• ✅ Sign-in / Sign-up with email ID and password
• ✅ Secure session management
• ✅ Email verification
• ✅ APIs to update profile securely
• ✅ Forgot password flow using email
• ✅ Social logins (Google, Github, Facebook, more coming soon)
• ✅ Role-based access management
• ✅ Password-less login with email and magic link

Roadmap

• Support more JWT encryption algorithms (Currently supporting HS256)
• 2 Factor authentication
• Back office (Admin dashboard to manage user)
• Support more database
• VueJS SDK
• Svelte SDK
• React Native SDK
• Flutter SDK
• Android Native SDK
• iOS native SDK
• Golang SDK
• Python SDK
• PHP SDK
• WordPress plugin
• Kubernetes Helm Chart
• Local Stack
• AMI
• Digital Ocean Droplet
• Azure
• Render
• Edge Deployment using Fly.io
• Password-less login with mobile number and OTP SMS

Getting Started

Trying out Authorizer

This guide helps you practice using Authorizer to evaluate it before you use it in a production environment. It includes instructions for installing the Authorizer server in local or standalone mode.

• Install using source code
• Install using binaries
• Install instance on heroku

Install using source code

Prerequisites

• OS: Linux or macOS or windows
• Go: (Golang)(https://golang.org/dl/) >= v1.15

Project Setup

1. Fork the authorizer repository (Skip this step if you have access to repo)
2. git clone https://github.com/authorizerdev/authorizer.git
3. cd authorizer
4. cp .env.sample .env. Check all the supported env here
5. Build the code make clean && make

   Note: if you don't have make, you can cd into server dir and build using the go build command

6. Run binary ./build/server

Install using binaries

Deploy / Try Authorizer using binaries. With each Authorizer Release binaries are baked with required deployment files and bundled. You can download a specific version of it for the following operating systems:

• Mac OSX
• Linux

Step 1: Download and unzip bundle

• Download the Bundle for the specific OS from the release page

Note: For windows, we recommend running using docker image to run authorizer.

• Unzip using following command

  • Mac / Linux

  tar -zxf AUTHORIZER_VERSION -c authorizer

• Change directory to authorizer

  cd authorizer

Step 2: Configure environment variables

Required environment variables are pre-configured in .env file. But based on the production requirements, please configure more environment variables. You can refer to environment variables docs for more information.

Step 3: Start Authorizer

• Run following command to start authorizer

  • For Mac / Linux users

  ./build/server

Note: For mac users, you might have to give binary the permission to execute. Here is the command you can use to grant permission xattr -d com.apple.quarantine build/server

Install instance on Heroku

Deploy Authorizer using heroku and quickly play with it in 30seconds

Things to consider

• For social logins, you will need respective social platform key and secret
• For having verified users, you will need an SMTP server with an email address and password using which system can send emails. The system will send a verification link to an email address. Once an email is verified then, only able to access it.

  Note: One can always disable the email verification to allow open sign up, which is not recommended for production as anyone can use anyone's email address 😅

• For persisting user sessions, you will need Redis URL. If you do not configure a Redis server, sessions will be persisted until the instance is up or not restarted. For better response time on authorization requests/middleware, we recommend deploying Redis on the same infra/network as your authorizer server.

Integrating into your website

This example demonstrates how you can use @authorizerdev/authorizer-js CDN version and have login ready for your site in few seconds. You can also use the ES module version of @authorizerdev/authorizer-js or framework-specific versions like @authorizerdev/authorizer-react

Copy the following code in html file

Note: Change AUTHORIZER_URL in the below code with your authorizer URL. Also, you can change the logout button component

<script src="https://unpkg.com/@authorizerdev/authorizer-js/lib/authorizer.min.js"></script>

<script type="text/javascript">
	const authorizerRef = new authorizerdev.Authorizer({
		authorizerURL: `AUTHORIZER_URL`,
		redirectURL: window.location.origin,
	});

	// use the button selector as per your application
	const logoutBtn = document.getElementById('logout');
	logoutBtn.addEventListener('click', async function () {
		await authorizerRef.logout();
		window.location.href = '/';
	});

	async function onLoad() {
		const res = await authorizerRef.browserLogin();
		if (res && res.user) {
			// you can use user information here, eg:
			/**
      const userSection = document.getElementById('user');
      const logoutSection = document.getElementById('logout-section');
      logoutSection.classList.toggle('hide');
      userSection.innerHTML = `Welcome, ${res.user.email}`;
      */
		}
	}
	onLoad();
</script>

---

Support my work