.. _ChapterStartUpOptions:

****************
Start Up Options
****************

Server Program Options
================================
By default the servers is started on the localhost and only processes running on that system could access the server.
The server provides the following startup arguments (:numref:`Server Program Options`).
Note: The package you received may not contain server. Please contact Aware if you are interested in server.

.. _Server Program Options:

.. table:: Server Program Options

    +---------------------------------------+--------------------------------------------+
    | **Argument**                          | **Description**                            |
    +=======================================+============================================+
    | **h [ --help ]**                      | Produce help message.                      |
    +---------------------------------------+--------------------------------------------+
    | **-c [ --config ]**                   | Load configuration from specified file.    |
    +---------------------------------------+--------------------------------------------+
    | **-l [ --log-config ]**               | Load log4cplus configuration from specified|
    |                                       | file.                                      |
    +---------------------------------------+--------------------------------------------+
    | **--host**                            | Set host name (default 0.0.0.0).           |
    +---------------------------------------+--------------------------------------------+
    | **-p [ --port ]**                     | Set port number (default 8080).            |
    +---------------------------------------+--------------------------------------------+
    | **-u [ --url-path ]**                 | URL base path                              |
    +---------------------------------------+--------------------------------------------+
    | **--certificate**                     | Path to PEM certificate keystore file,     |
    |                                       | enabling TLS.                              |
    +---------------------------------------+--------------------------------------------+
    | **--password**                        | TLS certificate private key password (use  |
    |                                       | if private key is encrypted).              |
    +---------------------------------------+--------------------------------------------+
    | **--enable-cors**                     | Enable Cross-Origin Resource               |
    |                                       | Sharing.                                   |
    +---------------------------------------+--------------------------------------------+
    | **--cors-acao-policy**                | Access-Control-Allow-Origin                |
    |                                       | policy (default "*").                      |
    +---------------------------------------+--------------------------------------------+
    | **--cors-acac-policy**                | Access-Control-Allow-Credentials           |
    |                                       | policy (default "").                       |
    +---------------------------------------+--------------------------------------------+
    | **--cors-aceh-policy**                | Access-Control-Expose-Headers              |
    |                                       | policy (default "").                       |
    +---------------------------------------+--------------------------------------------+
    | **--cors-acma-policy**                | Access-Control-Max-Age policy              |
    |                                       | (default "").                              |
    +---------------------------------------+--------------------------------------------+
    | **--cors-acam-policy**                | Access-Control-Allow-Methods               |
    |                                       | policy                                     |
    |                                       | (default "GET,POST,OPTIONS").              |
    +---------------------------------------+--------------------------------------------+
    | **--cors-acah-policy**                | Access-Control-Allow-Headers               |
    |                                       | policy (default "Content-Type").           |
    +---------------------------------------+--------------------------------------------+
    | **-w [ --workers ]**                  | Set number of workers. Defaults to one     |
    |                                       | worker per CPU core.                       |
    +---------------------------------------+--------------------------------------------+
    | **-o [ --f200-optimization-model ]**  | Set the path to F200 optimization model.   |
    |                                       | Defaults to F200_general.bin               |
    +---------------------------------------+--------------------------------------------+
    | **-o [ --f500-optimization-model ]**  | Set the path to F500 optimization model.   |
    |                                       | Defaults to F500_general.bin               |
    +---------------------------------------+--------------------------------------------+
    | **--f200**                            | Whether the F200 algorithm is enabled or   |
    |                                       | disabled. Defaults to disabled.            |
    +---------------------------------------+--------------------------------------------+
    | **--f500**                            | Whether the F500 algorithm is enabled or   |
    |                                       | disabled. Defaults to disabled.            |
    +---------------------------------------+--------------------------------------------+
    | **--cache.name**                      | Name of the cache.                         |
    +---------------------------------------+--------------------------------------------+
    | **--cache.dir**                       | Directory where the cache will be stored.  |
    +---------------------------------------+--------------------------------------------+
    | **--cache.max-encounters**            | Maximum number of encounters allowed in    |
    |                                       | the cache.                                 |
    +---------------------------------------+--------------------------------------------+
    | **--cache.f200**                      | Configuration for the F200                 |
    |                                       | algorithm. Acceptable values:              |
    |                                       | disabled - F200 data not stored in cache.  |
    |                                       | cache_ram - F200 stored in the RAM cache.  |
    |                                       | cache_disk - F200 stored in the disk cache.|
    +---------------------------------------+--------------------------------------------+
    | **--cache.f500**                      | Configuration for the F500                 |
    |                                       | algorithm. Acceptable values:              |
    |                                       | disabled - F500 data not stored in cache.  |
    |                                       | cache_ram - F500 stored in the RAM cache.  |
    |                                       | cache_disk - F500 stored in the disk cache.|
    +---------------------------------------+--------------------------------------------+
    | **--logged-image-path**               | Set path to store logged images.           |
    +---------------------------------------+--------------------------------------------+
    | **--endpoint-decryption-key**         | Path to endpoint decryption key,           |
    |                                       | enabling encrypted requests.               |
    +---------------------------------------+--------------------------------------------+
    | **--password-encrypted**              | Encrypted password using                   |
    |                                       | symmetric key.                             |
    +---------------------------------------+--------------------------------------------+
    | **--password-decryption-iv**          | Initiation vector that was used            |
    |                                       | to encrypt the passowrd.                   |
    +---------------------------------------+--------------------------------------------+
    | **--password-decryption-key**         | File containing symmetric key to           |
    |                                       | encrypt password.                          |
    +---------------------------------------+--------------------------------------------+
    | **--db-host**                         | Transaction counting database host server. |
    +---------------------------------------+--------------------------------------------+
    | **--db-user**                         | Transaction counting database              |
    |                                       | login user name.                           |
    +---------------------------------------+--------------------------------------------+
    | **--db-pw**                           | Transaction counting database              |
    |                                       | login password.                            |
    +---------------------------------------+--------------------------------------------+
    | **--db-name**                         | Transaction counting database name.        |
    +---------------------------------------+--------------------------------------------+
    | **--db-poll-interval**                | OPTIONAL: Transaction counting database    |
    |                                       | polling interval for reconnecting. Time    |
    |                                       | in minutes. Default 5 minutes.             |
    +---------------------------------------+--------------------------------------------+


Server Log Configuration
~~~~~~~~~~~~~~~~~~~~~~~~
The logging can be controlled by the parameters specified in the face_matcher_log_config.ini file.
This file defines what will be logged to the console and what will be logged to the log file. The default log configuration is set to roll over monthly.
The formatting options (i.e. [%-5p][%d] %m%n) in the Knomi logging configuration file are defined by the log4cplus library.  See (:numref:`Logging configuration example`).

.. code-block:: JAVA
 :caption: *Logging configuration example*
 :name: Logging configuration example

 # MyConsoleAppender
 log4cplus.appender.MyConsoleAppender=log4cplus::ConsoleAppender
 log4cplus.appender.MyConsoleAppender.layout=log4cplus::PatternLayout
 log4cplus.appender.MyConsoleAppender.layout.ConversionPattern=[%-5p][%d] %m%n

 # InfoLogAppender
 log4cplus.appender.InfoLogAppender=log4cplus::DailyRollingFileAppender
 log4cplus.appender.InfoLogAppender.File=./face_matcher_info.txt
 log4cplus.appender.InfoLogAppender.layout=log4cplus::PatternLayout
 log4cplus.appender.InfoLogAppender.layout.ConversionPattern=[%-5p][%d] %m%n
 log4cplus.appender.InfoLogAppender.Schedule=MONTHLY
 log4cplus.appender.InfoLogAppender.RollOnClose=false

 # JsonAppender
 log4cplus.appender.JsonAppender=log4cplus::DailyRollingFileAppender
 log4cplus.appender.JsonAppender.File=./face_matcher_stats.js
 log4cplus.appender.JsonAppender.layout=log4cplus::PatternLayout
 log4cplus.appender.JsonAppender.layout.ConversionPattern=%m%n
 log4cplus.appender.JsonAppender.Schedule=MONTHLY
 log4cplus.appender.JsonAppender.RollOnClose=false

 log4cplus.logger.aw_face_matcher_rest_server_info=INFO, MyConsoleAppender, InfoLogAppender
 log4cplus.logger.aw_face_matcher_rest_server_stats =INFO, MyConsoleAppender, JsonAppender