trace.moe-api

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 >= 22.15
• PostgreSQL 17+
• Milvus 2.6.0+
• FFmpeg
• Docker

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.
• Change TRACE_API_SALT to a unique value of at least 32 characters.

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 or webm). You can manually trigger a scan by calling this url

curl http://localhost:3001/scan

Local Development

Follow the installation instructions until the Start server step. Then proceed from here.
A compose.yml file is included for local development containing all the required dependencies.
On the first start, all database tables will be created in the database.

Running Locally

1. docker compose up -d
2. node server.js