faceplugin/face-recognition repository overview

⁠FacePlugin Face Recognition

On-premise face detection, quality, template extraction, and 1:1 match HTTP API. Linux amd64. Official image: faceplugin/face-recognition⁠.

The image is an API/SDK server only (no Gradio). Runtime is already inside — no Google Drive download is required to pull and run. This version is CPU-only.

• Company: faceplugin.com⁠
• Docs: doc.faceplugin.com⁠
• GitHub: Faceplugin-ltd/FaceRecognition-Linux-App⁠
• Contact: [email protected]⁠ · WhatsApp +1 469 278 4822⁠

⁠Tags

docker pull faceplugin/face-recognition:latest

⁠Quick start

Default listen port 8083.

docker run -d --name faceplugin-face-recognition \
  --shm-size=2gb --privileged \
  -p 8083:8083 \
  -v /etc/machine-id:/etc/machine-id:ro \
  faceplugin/face-recognition:latest

docker logs -f faceplugin-face-recognition
# Look for the machine code line: FPMC1.…

API: http://127.0.0.1:8083

macOS / Windows Docker Desktop: omit -v /etc/machine-id:/etc/machine-id:ro. Each container may get a different machine code.

⁠License

The published image does not include a license. The API starts without one and prints a machine code (FPMC1.…). Product endpoints unlock after you activate.

1. Copy the machine code from logs, or GET /api/machinecode.
2. Send that code to FacePlugin. You receive a license key (FP1.…).
3. Activate:

# Paste the FP1. key into license.txt, then:
curl -s -X POST http://127.0.0.1:8083/api/activate \
  -H 'Content-Type: text/plain' \
  --data-binary @license.txt

Docker and native-host codes are different. If you run in Docker, send the Docker machine code.

⁠Several containers, one license

On Linux, keep the machine-id mount. Use a new name and host port:

docker run -d --name faceplugin-face-recognition-2 \
  --shm-size=2gb --privileged \
  -p 8084:8083 \
  -v /etc/machine-id:/etc/machine-id:ro \
  faceplugin/face-recognition:latest

Activate each published port with the same key. Without the machine-id volume (typical Docker Desktop), codes can differ.

⁠API (after activation)

Health:

curl -s http://127.0.0.1:8083/api/health

Postman collection, Gradio demo (runs on the host, not in this image), and native setup: FaceRecognition-Linux-App⁠.