summaryrefslogtreecommitdiff
path: root/frags/using-taler-config.rst
blob: ba4febb4d0865b86eeafceb030f1ab8ae36ae991 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
Using taler-config
------------------

The tool ``taler-config`` can be used to extract or manipulate configuration
values; however, the configuration use the well-known INI file format and is
generally better edited by hand to preserve comments and structure.  Thus, ``taler-config`` should primarily be used
to inspect or understand a configuration that is in place,
and not to update it!

Run

.. code-block:: console

   $ taler-config -s $SECTION

to list all of the configuration values in section ``$SECTION``.

Run

.. code-block:: console

   $ taler-config -s $SECTION -o $OPTION

to extract the respective configuration value for option ``$OPTION`` in
section ``$SECTION``.

Finally, to change a setting and clobber your entire
configuration file structure, inlining all values and
removing all comments, run

.. code-block:: console

   $ taler-config -s $SECTION -o $OPTION -V $VALUE

to set the respective configuration value to ``$VALUE``. Note that you
have to manually restart affected Taler components after you change the
configuration to make the new configuration go into effect.

Some default options will use $-variables, such as ``$DATADIR`` within
their value. To expand the ``$DATADIR`` or other $-variables in the
configuration, pass the ``-f`` option to ``taler-config``. For example,
compare:

.. code-block:: console

   $ taler-config --section exchange-offline --option MASTER_PRIV_FILE
   $ taler-config -f --section exchange-offline --option MASTER_PRIV_FILE

While the configuration file is typically located at
``$HOME/.config/taler.conf``, an alternative location can be specified to any
GNU Taler component using the ``-c`` option.