devstack/authorizer
4
0
Fork 0
Code Pull Requests Actions Activity

fix: readme

Browse Source
This commit is contained in:
Lakhan Samani 2021-09-18 13:18:08 +05:30
parent 70c8353042
commit 195270525c
1 changed files with 30 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -7,10 +7,10 @@
Authorizer Authorizer
</h1> </h1>
**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. **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 ## Table of contents
- [Introduction](#introduction) - [Introduction](#introduction)
- [Getting Started](#getting-started) - [Getting Started](#getting-started)
- [Contributing](https://github.com/authorizerdev/authorizer/blob/main/.github/CONTRIBUTING.md) - [Contributing](https://github.com/authorizerdev/authorizer/blob/main/.github/CONTRIBUTING.md)
@ -65,9 +65,13 @@
## Trying out Authorizer ## 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 standalone mode. 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.
## Trying out locally using the code base - [Install using source code](#install-using-source-code)
- [Install using binaries](#install-using-binaries)
- [Install instance on heroku](#install-instance-on-Heroku)
## Install using source code
### Prerequisites ### Prerequisites
@ -84,7 +88,7 @@ This guide helps you practice using Authorizer to evaluate it before you use it
> Note: if you don't have [`make`](https://www.ibm.com/docs/en/aix/7.2?topic=concepts-make-command), you can `cd` into `server` dir and build using the `go build` command > Note: if you don't have [`make`](https://www.ibm.com/docs/en/aix/7.2?topic=concepts-make-command), you can `cd` into `server` dir and build using the `go build` command
6. Run binary `./build/server` 6. Run binary `./build/server`
## Trying out locally using binaries ## Install using binaries
Deploy / Try Authorizer using binaries. With each [Authorizer Release](https://github.com/authorizerdev/authorizer/releases) Deploy / Try Authorizer using binaries. With each [Authorizer Release](https://github.com/authorizerdev/authorizer/releases)
binaries are baked with required deployment files and bundled. You can download a specific version of it for the following operating systems: binaries are baked with required deployment files and bundled. You can download a specific version of it for the following operating systems:
@ -93,7 +97,6 @@ binaries are baked with required deployment files and bundled. You can download
- Linux - Linux
- Windows - Windows
### Step 1: Download and unzip bundle ### Step 1: Download and unzip bundle
- Download the Bundle for the specific OS from the [release page](https://github.com/authorizerdev/authorizer/releases) - Download the Bundle for the specific OS from the [release page](https://github.com/authorizerdev/authorizer/releases)
@ -127,6 +130,7 @@ Required environment variables are pre-configured in `.env` file. But based on t
### Step 3: Start Authorizer ### Step 3: Start Authorizer
- Run following command to start authorizer - Run following command to start authorizer
- For Mac / Linux users - For Mac / Linux users
```sh ```sh
@ -134,13 +138,14 @@ Required environment variables are pre-configured in `.env` file. But based on t
``` ```
- For windows - For windows
```sh ```sh
./build/server.exe ./build/server.exe
``` ```
> 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` > 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`
## Installing a simple instance of Authorizer on Heroku ## Install instance on Heroku
Deploy Authorizer using [heroku](https://github.com/authorizerdev/authorizer-heroku) and quickly play with it in 30seconds Deploy Authorizer using [heroku](https://github.com/authorizerdev/authorizer-heroku) and quickly play with it in 30seconds
<br/><br/> <br/><br/>
@ -171,10 +176,10 @@ This example demonstrates how you can use [`@authorizerdev/authorizer-js`](/auth
}); });
// use the button selector as per your application // use the button selector as per your application
const logoutBtn = document.getElementById("logout"); const logoutBtn = document.getElementById('logout');
logoutBtn.addEventListener("click", async function () { logoutBtn.addEventListener('click', async function () {
await authorizerRef.logout(); await authorizerRef.logout();
window.location.href = "/"; window.location.href = '/';
}); });
async function onLoad() { async function onLoad() {