authi

Authi

A lightweight authentication service written in go

About

Authi is a lightweight authentication service written in go. It covers the basic use cases of creating and deleting users as well as refresh tokens and update passwords.

Getting started

For a fast setup you can use the following guide:

Create a folder structure that looks like this:

.
├── docker-compose.yml
└── myTokenFolder

Paste into the docker-compose.yml the following content

version: '3.7'
services:
  postgres:
    image: postgres:latest
    container_name: postgres
    restart: always
    environment: 
      - POSTGRES_PASSWORD=myDatabasePassword
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U postgres"]
      interval: 5s
      timeout: 5s
      retries: 5 
  authi:
    image: "beancodede/authi:latest"
    container_name: authi
    restart: always
    environment: 
      - POSTGRES_PASSWORD=myDatabasePassword
    ports:
      - 1203:1203
    volumes: 
      - ./myTokenFolder:/token
    depends_on:
      postgres:
        condition: service_healthy
    links:
      - postgres:postgres

Execute the following two commands to generate key's

ssh-keygen -t rsa -b 4096 -m PEM -f ./myTokenFolder/jwtRS256.key

openssl rsa -in ./myTokenFolder/jwtRS256.key -pubout -outform PEM -out ./myTokenFolder/jwtRS256.key.pub

Note You need the cli programmes ssh-keygen and openssl in order to execute these commands

Start docker compose file

docker compose up

Note You need docker installed in order to execute this command

Configuration

The application can be started with different environment variables to configure specific behavior.

Adapter

TODO

API Interface

The offered api interfaces can be find in this Swagger UI or in the folder /docs.