summaryrefslogtreecommitdiff
path: root/taler-exchange-manual.rst
diff options
context:
space:
mode:
authorThien-Thi Nguyen <ttn@gnuvola.org>2020-12-11 00:56:30 -0500
committerThien-Thi Nguyen <ttn@gnuvola.org>2020-12-11 00:56:30 -0500
commit73718214548c59bb168641bdb5d45e18ecbd6d4d (patch)
tree3a0484f92acfe287f5bc228f6b89ea1976deb8df /taler-exchange-manual.rst
parentd18a6a8f92622123a678514bed61f94285a8f9c8 (diff)
downloaddocs-73718214548c59bb168641bdb5d45e18ecbd6d4d.tar.gz
docs-73718214548c59bb168641bdb5d45e18ecbd6d4d.tar.bz2
docs-73718214548c59bb168641bdb5d45e18ecbd6d4d.zip
replace ‘Configuration format’ and ‘Using taler-config’ w/ ‘include’ directives
Diffstat (limited to 'taler-exchange-manual.rst')
-rw-r--r--taler-exchange-manual.rst120
1 files changed, 2 insertions, 118 deletions
diff --git a/taler-exchange-manual.rst b/taler-exchange-manual.rst
index e68bdf8..468950b 100644
--- a/taler-exchange-manual.rst
+++ b/taler-exchange-manual.rst
@@ -297,128 +297,12 @@ This chapter provides an overview of the exchange configuration. Or at
least eventually will do so, for now it is a somewhat wild description
of some of the options.
-Configuration format
---------------------
-In Taler realm, any component obeys to the same pattern to get
-configuration values. According to this pattern, once the component has
-been installed, the installation deploys default values in
-${prefix}/share/taler/config.d/, in .conf files. In order to override
-these defaults, the user can write a custom .conf file and either pass
-it to the component at execution time, or name it taler.conf and place
-it under $HOME/.config/.
+.. include:: frags/configuration-format.rst
-A config file is a text file containing sections, and each section
-contains its values. The right format follows:
-.. code-block:: ini
-
- [section1]
- value1 = string
- value2 = 23
-
- [section2]
- value21 = string
- value22 = /path22
-
-Throughout any configuration file, it is possible to use ``$``-prefixed
-variables, like ``$VAR``, especially when they represent filesystem
-paths. It is also possible to provide defaults values for those
-variables that are unset, by using the following syntax:
-``${VAR:-default}``. However, there are two ways a user can set
-``$``-prefixable variables:
-
-by defining them under a ``[paths]`` section, see example below,
-
-.. code-block:: ini
-
- [paths]
- TALER_DEPLOYMENT_SHARED = ${HOME}/shared-data
- ..
- [section-x]
- path-x = ${TALER_DEPLOYMENT_SHARED}/x
-
-or by setting them in the environment:
-
-.. code-block:: console
-
- $ export VAR=/x
-
-The configuration loader will give precedence to variables set under
-``[path]``, though.
-
-The utility ``taler-config``, which gets installed along with the
-exchange, serves to get and set configuration values without directly
-editing the .conf. The option ``-f`` is particularly useful to resolve
-pathnames, when they use several levels of ``$``-expanded variables. See
-``taler-config --help``.
-
-Note that, in this stage of development, the file
-``$HOME/.config/taler.conf`` can contain sections for *all* the
-component. For example, both an exchange and a bank can read values from
-it.
-
-The repository ``git://taler.net/deployment`` contains examples of
-configuration file used in our demos. See under ``deployment/config``.
-
- **Note**
-
- Expectably, some components will not work just by using default
- values, as their work is often interdependent. For example, a
- merchant needs to know an exchange URL, or a database name.
-
-.. _Using-taler_002dconfig-exchange:
-
-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 can also be edited by hand.
-
-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, 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 the Taler backend 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 -s ACCOUNT-bank \
- -o WIRE_RESPONSE
- $ taler-config -f -s ACCOUNT-bank \
- -o WIRE_RESPONSE
+.. include:: frags/using-taler-config.rst
-While the configuration file is typically located at
-``$HOME/.config/taler.conf``, an alternative location can be specified
-to ``taler-merchant-httpd`` and ``taler-config`` using the ``-c``
-option.
.. _Keying: