Skip to content

Latest commit

 

History

History
67 lines (48 loc) · 2.19 KB

README.md

File metadata and controls

67 lines (48 loc) · 2.19 KB
Raw

trace.moe-api

License GitHub Workflow Status Codecov Docker Docker Image Size Discord

API server for trace.moe

API Docs

Features

  • serve image search request
  • crop black borders on search images
  • rate limiting and user management
  • serve index and database status
  • store and serve compressed hash files
  • distribute hash jobs to workers

Prerequisites

  • Node.js 20.x
  • mariaDB 10.4.x
  • ffmpeg 4.x
  • java (openjdk 17)
  • liresolr
  • g++, cmake (if you need to compile OpenCV)

Install

Install Prerequisites first, then:

git clone https://github.com/soruly/trace.moe-api.git
cd trace.moe-api
npm install

Configuration

  • Copy .env.example to .env
  • Edit .env as appropriate for your setup, i.e. VIDEO_PATH and HASH_PATH

Start server

You can use pm2 to run this in background in cluster mode.

Use below commands to start / restart / stop server.

npm run start
npm run stop
npm run reload
npm run restart
npm run delete

How to begin hashing

By default, it will scan the VIDEO_PATH every minute for new video files (.mp4 or .mkv). You can manually trigger a scan by calling this url

curl http://localhost:3001/scan