taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

using-taler-config.rst (2035B)


      1 Using taler-\*-config
      2 ---------------------
      3 
      4 GNU Taler comes with various tools all called ``taler-$COMPONENT-config``,
      5 such as ``taler-exchange-config`` and ``taler-merchant-config``.  They
      6 all behave the same way, but are accessing the default configurations
      7 of the respective ``$COMPONENT``. In this man page we will thus simply
      8 refer to these tools as the ``$TALER_CONFIG`` tool.
      9 
     10 The ``$TALER_CONFIG`` tool can be used to extract or manipulate configuration
     11 values; however, the configuration use the well-known INI file format and is
     12 generally better edited by hand to preserve comments and structure.  Thus, ``$TALER_CONFIG`` should primarily be used
     13 to inspect or understand a configuration that is in place,
     14 and not to update it!
     15 
     16 Run
     17 
     18 .. code-block:: console
     19 
     20    $ $TALER_CONFIG -s $SECTION
     21 
     22 to list all of the configuration values in section ``$SECTION``.
     23 
     24 Run
     25 
     26 .. code-block:: console
     27 
     28    $ $TALER_CONFIG -s $SECTION -o $OPTION
     29 
     30 to extract the respective configuration value for option ``$OPTION`` in
     31 section ``$SECTION``.
     32 
     33 Finally, to change a setting and clobber your entire
     34 configuration file structure, inlining all values and
     35 removing all comments, run
     36 
     37 .. code-block:: console
     38 
     39    $ $TALER_CONFIG -s $SECTION -o $OPTION -V $VALUE
     40 
     41 to set the respective configuration value to ``$VALUE``. Note that you
     42 have to manually restart affected Taler components after you change the
     43 configuration to make the new configuration go into effect.
     44 
     45 Some default options will use $-variables, such as ``$DATADIR`` within
     46 their value. To expand the ``$DATADIR`` or other $-variables in the
     47 configuration, pass the ``-f`` option to ``$TALER_CONFIG``. For example,
     48 compare:
     49 
     50 .. code-block:: console
     51 
     52    $ $TALER_CONFIG --section exchange-offline --option MASTER_PRIV_FILE
     53    $ $TALER_CONFIG -f --section exchange-offline --option MASTER_PRIV_FILE
     54 
     55 While the configuration file is typically located at
     56 ``$HOME/.config/taler-$COMPONENT.conf``,
     57 an alternative location can be specified to any
     58 GNU Taler component using the ``-c`` option.