diff options
| author | Paul Buetow <paul@buetow.org> | 2020-02-08 11:18:52 +0000 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2020-02-08 11:18:52 +0000 |
| commit | ae6e9b57500810fff81fe25b4d3080010327d358 (patch) | |
| tree | de9e2a34ff6fe37a8fd871372259e0079f6612c2 | |
| parent | cab409a368654e56948a6f82e3beb20925ae4a7d (diff) | |
improve documentation
| -rw-r--r-- | doc/installation.md | 13 | ||||
| -rw-r--r-- | doc/quickstart.md | 15 |
2 files changed, 22 insertions, 6 deletions
diff --git a/doc/installation.md b/doc/installation.md index a15beb1..75f93d5 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -21,6 +21,7 @@ It is recommended to automate all the installation process outlined here. You co 2. Create the ``dserver`` run user and group. The user could look like this: ```console +% sudo adduser dserver % id dserver uid=670(dserver) gid=670(dserver) groups=670(dserver) ``` @@ -34,8 +35,20 @@ uid=670(dserver) gid=670(dserver) groups=670(dserver) 4. Install the ``dtail.json`` config to ``/etc/dserver/dtail.json``. An example can be found [here](../samples/dtail.json.sample). +```console +% sudo mkdir /etc/dserver +% curl https://raw.githubusercontent.com/mimecast/dtail/master/samples/dtail.json.sample | + sudo tee /etc/dserver/dtail.json >/dev/null +``` + 5. It is recommended to configure DTail server as a service to ``systemd``. An example unit file for ``systemd`` can be found [here](../samples/dserver.service.sample). +```console +% curl https://raw.githubusercontent.com/mimecast/dtail/master/samples/dserver.service.sample | + sudo tee /etc/systemd/system/dserver.service >/dev/null +% sudo systemctl daemon-reload +``` + # Start it To start the DTail server via ``systemd`` run: diff --git a/doc/quickstart.md b/doc/quickstart.md index de50d06..10b9589 100644 --- a/doc/quickstart.md +++ b/doc/quickstart.md @@ -7,15 +7,18 @@ This guide assumes that you know how to generate and configure a public/private # Install it +On Linux you need to install the libacl development library for file system ACL permission support in `dserver`. On CentOS and/or Fedora it would be + +```console +% sudo yum install libacl-devel -y +``` + To compile and install all DTail binaries directly from GitHub run: ```console -% go get github.com/mimecast/dtail/cmd/dcat -% go get github.com/mimecast/dtail/cmd/dgrep -% go get github.com/mimecast/dtail/cmd/dmap -% go get github.com/mimecast/dtail/cmd/drun -% go get github.com/mimecast/dtail/cmd/dtail -% go get github.com/mimecast/dtail/cmd/dserver +% for cmd in dcat dgrep dmap drun dtail dserver; do + go get github.com/mimecast/dtail/cmd/$cmd; + done ``` It produces the following executables in ``$GOPATH/bin``: |