README.md

Tizori Backend 🔐

Backend API and admin panel for self-hosted credentials manager with role-based access control (RBAC).

Table of Contents

• Key Features
• Tech Stack and Dependencies
  • Deployment
  • Web API
  • Admin Panel
  • Database
• Setting-up and Installation
  • Prerequisites
  • Configure the environment variables
• Usage
  • Running the application
  • Stopping the application
  • Using management commands of the CLI application
• Developer

Key Features

• User management and authentication using JWT
• Role-based access control (RBAC) and role management
• Applications management
• Credentials management and encryption using AES

Tech Stack and Dependencies

Deployment

• Docker

Web API

• Language - Go
• Framework - Fiber
• ORM - Gorm
• CLI framework - urfave/cli
• JWT - golang-jwt
• UUID - google/uuid
• AES Encryption - crypto/aes

Admin Panel

• Language - Python
• Framework - Django
• Admin Template - Jazzmin

Database

• PostgreSQL

Setting-up and Installation

Prerequisites

• Download and install Docker and Docker compose
• Clone the repository using the following command -

git clone https://github.com/Dhruv9449/tizori-backend.git

Configure the environment variables

Configure the env files present in /tizori/.env/
For local environment use .local and for production use .production

Following environment variables need to be configured -

• FIBER_PORT - Value of port used by the web api in the form :<PORT>, default value is :3000
• DEBUG - Set to true for local environment, false for production environment
• POSTGRES_URL - Set to postgres://<POSTGRES_USER>:<POSTGRES_PASSWORD>@postgres:<POSTGRES_PORT>/<POSTGRES_DB>
• POSTGRES_USER - Username for postgres database
• POSTGRES_PASSWORD - Password for postgres database
• POSTGRES_DB - Name of the postgres database
• POSTGRES_HOST - Hostname for postgres database, default value is postgres
• POSTGRES_PORT - Port for postgres database, default value is 5432
• JWT_SECRET - JWT secret key that will be used to sign the tokens
• AES_KEY - AES key used for encryption and decryption of credentials

Seed the database

Use the following command to seed the database with initial roles data -

./tizori.sh seed

Usage

Running the application

Use the following command to run the application -

MacOS and Linux

./tizori.sh up

Windows

tizori.cmd up

Stopping the application

Use the following command to stop the application -

MacOS and Linux

./tizori.sh down

Windows

tizori.cmd down

Using management commands of the CLI application

Use the following command to run the CLI application -

MacOS and Linux

./tizori.sh cli <command>

Windows

tizori.cmd cli <command>

Developer

Dhruv Shah

Made with ❤️ by Dhruv Shah