Docs / Face Recognition And Liveness SDK / Backup And Upgrade
Backup And Upgrade
Back up the Face SDK data volume, restore it on the same or a new server, and upgrade to a new version without losing people, keys or settings.
Everything the Face SDK keeps is on one Docker volume (face-data in the one-command install): the database, the master key that encrypts it, and the licence state.
Back Up
-
Stop the container so the database is consistent:
sudo docker stop face-sdk. -
Copy the volume to an archive:
sudo docker run --rm -v face-data:/data -v "$PWD":/backup debian:bookworm-slim \ tar czf /backup/face-sdk-$(date +%F).tgz -C /data . -
Start it again:
sudo docker start face-sdk.
Keep the archive as safe as the server: it holds the master key and the encrypted data together.
Restore
Create an empty volume, unpack the archive into it, and start the container with that volume. On a different machine the licence must be activated there (Demo: this counts as one of its two moves).
Upgrade
-
Back up.
-
Pull the new image and recreate the container with the same volume and settings:
sudo docker rm -f face-sdk sudo docker run -d --name face-sdk ... <registry>/face-sdk:<new version>-prod-cpu -
Check
GET /v2/infofor the new version.
When a release changes a recognition model, people enrolled with the old model are listed for re-enrolment and searches answer NEEDS_REENROLMENT for them. With “keep face crops” on, they can be re-enrolled without new photos.
[CONFIRM] Prod upgrade path for the Compose install (install bundle of the new version) at release.
API v2. Updated 2026-11-12