extern/zrepl
1
0
Fork 0
mirror of https://github.com/zrepl/zrepl.git synced 2024-11-24 17:35:01 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: adjust install page regarding changes to logging.

Browse Source
This commit is contained in:
Christian Schwarz 2017-09-24 11:02:35 +02:00
parent 1c3e4e2f07
commit 4e4bf3dbd8
1 changed files with 9 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/content/install/_index.md
View File

@ -43,12 +43,14 @@ zrepl searches for its main configuration file in the following locations (in th
* `/etc/zrepl/zrepl.yml` * `/etc/zrepl/zrepl.yml`
* `/usr/local/etc/zrepl/zrepl.yml` * `/usr/local/etc/zrepl/zrepl.yml`
Alternatively, use CLI flags to specify a config location.
Copy a config from the [tutorial](/tutorial) or the `cmd/sampleconf` directory to one of these locations and customize it to your setup. Copy a config from the [tutorial](/tutorial) or the `cmd/sampleconf` directory to one of these locations and customize it to your setup.
## Runtime Directories ## Runtime Directories
Check the the [configuration documentation]({{< relref "configuration/misc.md#runtime-directories-unix-sockets" >}}) for more information.
For default settings, the following should to the trick. For default settings, the following should to the trick.
Check out the [configuration documentation]({{< relref "configuration/misc.md#runtime-directories-unix-sockets" >}}) for more information.
```bash ```bash
mkdir -p /var/run/zrepl/stdinserver mkdir -p /var/run/zrepl/stdinserver
@ -58,27 +60,20 @@ chmod -R 0700 /var/run/zrepl
## Running the Daemon ## Running the Daemon
All work zrepl done is performed by a daemon process. All actual work zrepl does is performed by a daemon process.
There are no *rc(8)* or *systemd.service(5)* service definitions yet. Logging is configurable via the config file. Please refer to the [logging documentation]({{< relref "configuration/logging.md" >}}).
The daemon does not fork and writes all log output to stderr.
```bash ```bash
zrepl daemon zrepl daemon
``` ```
FreeBSD ships with the *daemon(8)* utility which is also a good start for writing an *rc(8)* file: There are no *rc(8)* or *systemd.service(5)* service definitions yet. Note the *daemon(8)* utility on FreeBSD.
```bash
daemon -o /var/log/zrepl.log \
-p /var/run/zrepl/daemon.pid \
zrepl --config /usr/local/etc/zrepl/zrepl.yml daemon
```
{{% notice info %}} {{% notice info %}}
Make sure to read the first lines of log output after the daemon starts: if the daemon cannot create the [stdinserver]({{< relref "configuration/transports.md#stdinserver" >}}) sockets Make sure to actually monitor the error level output of zrepl: some configuration errors will not make the daemon exit.<br />
in the runtime directory, it will complain but not terminate as other tasks such as taking periodic snapshots might still work and are equally important. Example: if the daemon cannot create the [stdinserver]({{< relref "configuration/transports.md#stdinserver" >}}) sockets
in the runtime directory, it will emit an error message but not exit because other tasks such as periodic snapshots & pruning are of equal importance.
{{% / notice %}} {{% / notice %}}
### Restarting ### Restarting