extern/zrepl
1
0
Fork 0
mirror of https://github.com/zrepl/zrepl.git synced 2025-08-14 00:58:24 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: move config files + runtime dir doc to new configuration/preface

Browse Source
This commit is contained in:
Christian Schwarz
2017-12-27 18:34:02 +01:00
parent 7ac2821147
commit 03ba2bb7c8
7 changed files with 75 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/configuration/logging.rst
View File

@ -31,6 +31,8 @@ Check out :sampleconf:`random/logging.yml` for an example on how to configure mu
The **first outlet is special**: if an error writing to any outlet occurs, the first outlet receives the error and can print it.
Thus, the first outlet must be the one that always works and does not block, e.g. ``stdout``, which is the default.
.. _logging-default-config:
Default Configuration
---------------------

3
docs/configuration/misc.rst
View File

@ -13,10 +13,9 @@ zrepl daemon creates various UNIX sockets to allow communicating with it:
There is no further authentication on these sockets.
Therefore we have to make sure they can only be created and accessed by ``zrepl daemon``.
In fact, ``zrepl daemon`` will not bind a socket to a path in a directory that is world-accessible.
The directories can be configured in the main configuration file:
The directories can be configured in the main configuration file, the defaults are provided below:
::

33
docs/configuration/preface.rst Normal file
View File

@ -0,0 +1,33 @@
.. _configuration_preface:
=======
Preface
=======
-----------------------
Configuration File Path
-----------------------
zrepl searches for its main configuration file in the following locations (in that order):
* If set, the location specified via the global ``--config`` flag
* ``/etc/zrepl/zrepl.yml``
* ``/usr/local/etc/zrepl/zrepl.yml``
The examples in the :ref:`tutorial` or the ``cmd/sampleconf`` directory should provide a good starting point.
-------------------
Runtime Directories
-------------------
zrepl requires runtime directories for various UNIX sockets --- they are documented in the :ref:`config file<conf-runtime-directories>`.
Your package maintainer / init script should take care of creating them.
Alternatively, for default settings, the following should to the trick.
::
mkdir -p /var/run/zrepl/stdinserver
chmod -R 0700 /var/run/zrepl