.. _docker-commands:

Post-deployment Procedures and How-to's
---------------------------------------------------------------

After you are finished with the FindFace CIBR deployment, perform the procedures below. 

.. rubric:: In this section:

.. contents::
   :local:


Specify Time Zone
^^^^^^^^^^^^^^^^^^^^^^

The time zone on the FindFace CIBR server determines the time in reports, logs, and names of such FindFace CIBR artifacts as detection full frames and thumbnails, etc. 

The time zone is specified in the ``/opt/findface-cibr/configs/findface-multi-legacy/findface-multi-legacy.py`` configuration file, either in the ``Region/Country/City`` or ``Etc/GMT+H`` format. The best way to do so is to copy/paste your time zone from `this table <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>`_ on Wikipedia.

.. code::

   sudo vi /opt/findface-cibr/configs/findface-multi-legacy/findface-multi-legacy.py

   # time zone
   TIME_ZONE = 'America/Argentina/Buenos_Aires'

Restart the ``findface-cibr-findface-multi-legacy-1`` container.

.. code::

   sudo docker container restart findface-cibr-findface-multi-legacy-1

License Instance
^^^^^^^^^^^^^^^^^^^^^^

FindFace CIBR provides several licensing options. Whichever option you choose, you upload the FindFace CIBR license file via the main web interface ``http://<Host_IP_address>/#/license``. To access the web interface, use the ``superuser`` credentials.

.. important::
   Do not disclose the ``superuser`` (Super Administrator) credentials to others. To administer the system, create a new user with administrator privileges. Whatever the role, the Super Administrator cannot be deprived of its rights.

Refer to the :ref:`licensing-principles` section to learn about the licensing options available.

Configure Logging
^^^^^^^^^^^^^^^^^^^^

By default, the FindFace CIBR processes are logged to `Docker container logs <https://docs.docker.com/config/containers/logging/>`__,  which can be accessed via the ``docker logs`` and ``docker service logs`` commands. In addition, Docker uses the `json-file logging driver <https://docs.docker.com/config/containers/logging/json-file/>`__, which caches container logs in JSON.  You can configure Docker to use another logging driver, choosing from the `multiple logging mechanisms available <https://docs.docker.com/config/containers/logging/configure/>`__. See :ref:`logs` to learn how to do it.

.. _useful-docker-commands:

Useful Docker Commands
^^^^^^^^^^^^^^^^^^^^^^^^^

In order to efficiently and easily administer FindFace CIBR, you must have extensive knowledge and skills with Docker. If you're new to Docker, get started with the commands below. Then explore the Docker documentation for additional skills.

* View all Docker containers, including the stopped ones:

  .. code::

     docker ps -a
 
  To get a more compact and understandable output, execute:

  .. code::

     docker ps -a --format "table {{.ID}}\t{{.Names}}\t{{.Status}}\t{{.State}}"
 
  To extend the previous output, execute:

  .. code::

     docker ps --format='{{json .}}' | jq

* Restart the Docker service:

  .. code::

     sudo systemctl restart docker
 
* View a container log if the ``journald`` logging driver is :ref:`enabled <logs>`:


  .. code::

     journalctl CONTAINER_NAME=findface-cibr-findface-multi-legacy-1 -f

* Stop a Docker container:

  .. code::

     sudo docker container stop <container_name>/<container_id>

  Stop all Docker containers:

  .. code::

     sudo docker container stop $(sudo docker ps -a -q) 

* Start a Docker container:

  .. code::

     sudo docker container start <container_name>/<container_id>

  Start all Docker containers:

  .. code::

     sudo docker container start $(sudo docker ps -a -q) 
 
* The FindFace CIBR ``docker-compose.yaml`` file can be viewed as such:

  .. code::

     cat /opt/findface-cibr/docker-compose.yaml
     
* FindFace CIBR configuration files can be found here: 

  .. code::

      cd /opt/findface-cibr/configs/
 
  Once you made changes to a configuration file, restart a relevant container by executing:

  .. code::

     sudo docker container restart <container_name>/<container_id>

* Enter a running Docker container to execute a command in it:

  .. code::

     sudo docker container exec -it <container_name> /bin/bash

* Stop and remove all FindFace CIBR containers:

  .. code::

     cd /opt/findface-cibr/
     sudo docker-compose down

* Build, recreate, and start FindFace CIBR containers:

  .. code::

     cd /opt/findface-cibr/
     sudo docker-compose up -d