.. _docker-commands:

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

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

.. rubric:: In this section:

.. contents::
   :local:

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

FindFace Server provides several licensing options. Whichever option you choose, you upload the FindFace Server license file via ``ntls`` web interface ``http://<Host_IP_address>:3185/``.

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

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

By default, the FindFace Server 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 stores container logs in JSON files.  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 Server, 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-container_name> -f

* Stop a Docker container:

  .. code::

     docker container stop <container_name>/<container_id>

  Stop all Docker containers:

  .. code::

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

* Start a Docker container:

  .. code::

     docker container start <container_name>/<container_id>

  Start all Docker containers:

  .. code::

     docker container start $(docker ps -a -q)


* Once you made changes to a configuration file, restart a relevant container by executing:

  .. code::

     docker container restart <container_name>/<container_id>

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

  .. code::

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