summaryrefslogtreecommitdiff
path: root/manpages/sync.conf.5.rst
blob: f2a0e6a965a39e6ad428652130290cf6a1c298a2 (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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
sync.conf(5)
############

.. only:: html

   Name
   ====

   **sync.conf** - Sync configuration file


Description
===========

.. include:: ../frags/common-conf-syntax.rst

Files containing default values for many of the options described below
are installed under ``$PREFIX/share/sync/config.d/``.
The configuration file given with **-c** to Sync binaries
overrides these defaults.

A configuration file may include another, by using the ``@INLINE@`` directive,
for example, in ``main.conf``, you could write ``@INLINE@ sub.conf`` to
include the entirety of ``sub.conf`` at that point in ``main.conf``.

Be extra careful when using ``sync-config -V VALUE`` to change configuration
values: it will destroy all uses of ``@INLINE@`` and furthermore remove all
comments from the configuration file!


GLOBAL OPTIONS
--------------

The following options are from the “[sync]” section.
This is normally the only section in a sync.conf file.

SERVE
  This can either be ``tcp`` or ``unix``.

PORT
  Port on which the HTTP server listens, e.g. 9967.
  Only used if ``SERVE`` is ``tcp``.

BIND_TO
  Which IP address should we bind to?  E.g. ``127.0.0.1`` or ``::1``
  for loopback.  Can also be given as a hostname.  We will bind to
  the wildcard (dual-stack) if left empty.
  Only used if ``SERVE`` is ``tcp``.

UNIXPATH
  Which unix domain path should we bind to?
  Only used if ``SERVE`` is ``unix``.

UNIXPATH_MODE = 660
  What should be the file access permissions for ``UNIXPATH``?
  Only used if ``SERVE`` is ``unix``.

DB
  Plugin to use for the database, e.g. “postgres”.

ANNUAL_FEE
  Annual fee for an account.
  This is in the usual amount syntax, e.g. ``TESTKUDOS:0.1``.

INSURANCE
  Insurance provided against loss, e.g. ``TESTKUDOS:0.0``.

UPLOAD_LIMIT_MB
  Upload limit per backup, in megabytes, e.g. ``16``.

FULFILLMENT_URL
  Fulfillment URL of the SYNC service itself.

PAYMENT_BACKEND_URL
  Base URL of our payment backend.

API_KEY
  API key to pass when accessing the merchant backend.
  This is a secret value.


SEE ALSO
========

sync-dbinit(1), sync-httpd(1), sync-config(1).


BUGS
====

Report bugs by using https://bugs.taler.net/ or by sending electronic
mail to <taler@gnu.org>.