sync.conf.5.rst (2352B)
1 sync.conf(5) 2 ############ 3 4 .. only:: html 5 6 Name 7 ==== 8 9 **sync.conf** - Sync configuration file 10 11 12 Description 13 =========== 14 15 .. include:: ../frags/common-conf-syntax.rst 16 17 Files containing default values for many of the options described below 18 are installed under ``$PREFIX/share/sync/config.d/``. 19 The configuration file given with **-c** to Sync binaries 20 overrides these defaults. 21 22 A configuration file may include another, by using the ``@INLINE@`` directive, 23 for example, in ``main.conf``, you could write ``@INLINE@ sub.conf`` to 24 include the entirety of ``sub.conf`` at that point in ``main.conf``. 25 26 Be extra careful when using ``sync-config -V VALUE`` to change configuration 27 values: it will destroy all uses of ``@INLINE@`` and furthermore remove all 28 comments from the configuration file! 29 30 31 GLOBAL OPTIONS 32 -------------- 33 34 The following options are from the “[sync]” section. 35 This is normally the only section in a sync.conf file. 36 37 SERVE 38 Should the HTTP server listen on a UNIX domain socket (set option to "unix"), or on a TCP socket (set option to "tcp"), or be activated via systemd (set option to "systemd"). 39 40 PORT 41 Port on which the HTTP server listens, e.g. 9967. 42 Only used if ``SERVE`` is ``tcp``. 43 44 BIND_TO 45 Which IP address should we bind to? E.g. ``127.0.0.1`` or ``::1`` 46 for loopback. Can also be given as a hostname. We will bind to 47 the wildcard (dual-stack) if left empty. 48 Only used if ``SERVE`` is ``tcp``. 49 50 UNIXPATH 51 Which unix domain path should we bind to? 52 Only used if ``SERVE`` is ``unix``. 53 54 UNIXPATH_MODE = 660 55 What should be the file access permissions for ``UNIXPATH``? 56 Only used if ``SERVE`` is ``unix``. 57 58 DB 59 Plugin to use for the database, e.g. “postgres”. 60 61 ANNUAL_FEE 62 Annual fee for an account. 63 This is in the usual amount syntax, e.g. ``TESTKUDOS:0.1``. 64 65 INSURANCE 66 Insurance provided against loss, e.g. ``TESTKUDOS:0.0``. 67 68 UPLOAD_LIMIT_MB 69 Upload limit per backup, in megabytes, e.g. ``16``. 70 71 FULFILLMENT_URL 72 Fulfillment URL of the SYNC service itself. 73 74 PAYMENT_BACKEND_URL 75 Base URL of our payment backend. 76 77 API_KEY 78 API key to pass when accessing the merchant backend. 79 This is a secret value. 80 81 82 SEE ALSO 83 ======== 84 85 sync-dbinit(1), sync-httpd(1), sync-config(1). 86 87 88 BUGS 89 ==== 90 91 Report bugs by using https://bugs.taler.net/ or by sending electronic 92 mail to <taler@gnu.org>.