Installation

Before proceeding with the installation of the application, you must ensure that you meet the requirements.

In general, the only requirement for the operation of the application outside the standard is the PHP extension for Dlib. It is a relatively new extension, which unfortunately is unlikely to be packaged for your distribution. To bring access to this application closer to more domestic users, we try to keep the packages in the most popular distributions to simplify their installation. See PDlib-Installation

Once you are sure you have all needed requirements, this is how you can install FaceRecognition app. In general, you will need to install PDlib library (this is PHP wrapper for DLib) and FaceRecognition app (this app).

Once you did that, you can install FaceRecognition app from Nextcloud app store.

⚠️ (It is not possible yet. Try manual way.

Head over to Usage to see where to start from there!

Install FaceRecognition app

In general, there is no need to install FaceRecognition from source, please use Nextcloud app store. This is needed only if you want to change source code and to contribute (in which case - big welcome!:smile:). Here is how you can install it on Ubuntu:

sudo apt-get install git-core composer
cd nextcloud/apps/   # or whatever your path to Nextcloud is
git clone https://github.com/matiasdelellis/facerecognition.git
cd facerecognition/
make

If you want to update to latest from master:

cd nextcloud/apps/facerecognition/
git pull
make

Setup

After installing the application and enable it, you must indicate how much maximum memory you want to assign to the process, and you must install the models. Within the Nextcloud folder, you must execute the following command with your HTTP user:

cd nextcloud/  # or whatever your path to Nextcloud is
sudo -u www-data php occ app:enable facerecognition # or ./occ app:enable facerecognition
sudo -u www-data php occ face:setup -M MEMORY # or ./occ face:setup --memory MEMORY
sudo -u www-data php occ face:setup -m MODEL_ID # or ./occ face:setup -m MODEL_ID

Congratulations, you should now have complete FaceRecognition set up!

Again, head over to Usage to see where to start from there.

Docker way

We are aware that many users use Docker for their Nextcloud instances. We try to document some examples to help you quickly get started with Facerecognition using Docker.

See our docker documentation here: