Installation

Prerequisites

• Python 3.x
• Node.js at least 22.x (I haven't tested this in other environments)
• Node Package Manager, to install other dependencies
• TSC(TypeScript Compiler) to compile the project

Setting up

Note

If you're using Python 3.12 on Linux you can face bad problem with distutils which was deleted from python 3.12, you'll need to install it manually, google it for your distribution, here is some for popular ones

# Arch (and Arch based-distros)
pacman -S python-distutils-extra
# Ubuntu (and Ubuntu based-distros)
sudo apt-get install python3-distutils
# Fedora (and Fedora based-distros)
dnf install python3-distutils-extra

To setup TypeAuthD you will need to clone this repository, and install necessary dependencies. Here is the full bash

git clone https://github.com/JerryImMouse/typeauthd.git
cd typeauthd
npm install --omit=dev # install all production dependencies, this includes all dependencies to build project
npm run build # compile .ts to .js files, output will be placed to ./dist folder

After installation you can easily run typeauthd using:

npm start

or use the main file directly via

node dist/index.js

Docker

To set typeauthd via docker you can use github package registry(ghcr) or build it on your own.

Using GHCR

docker run -d \
  --name "typeauthd" \
  -p 127.0.0.1:6000:2424 \
  -e NODE_ENV=production \
  -v /path/to/appconfig.json:/app/appconfig.json \
  ghcr.io/jerryimmouse/typeauthd:latest

Compose file

services:
  typeauthd.stalker:
    image: jerryimmouse/typeauthd:latest
    container_name: "typeauthd"
    hostname: "typeauthd"
    ports:
      - 127.0.0.1:6000:2424
    environment:
      - NODE_ENV=production
    volumes:
      - /path/to/appconfig.json:/app/appconfig.json

Using Dockerfile

Using dockerfile means building typeauthd image on your own.

git clone https://github.com/JerryImMouse/typeauthd.git
cd typeauthd
docker build -t typeauthd .
docker run -d \
  --name "typeauthd" \
  -p 127.0.0.1:6000:2424 \
  -e NODE_ENV=production \
  -v /path/to/appconfig.json:/app/appconfig.json \
  typeauthd:latest