diff options
| author | pbuetow <35781042+pbuetow@users.noreply.github.com> | 2020-02-08 11:26:32 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-08 11:26:32 +0000 |
| commit | 4f20e035eb9a924d94bf5eb86cbaa015ddc9d7b5 (patch) | |
| tree | daf0b88895a91f0ded9ab97099ae891563ba9c26 /doc | |
| parent | f0c01a3c238c2bd847d83fc1faa8f1114dce856f (diff) | |
| parent | e2896cf8f09fbfa0244c91f75a0e243352f36463 (diff) | |
Merge pull request #2 from snonux/masterv2.0.1
Invalid json error fix and minor improvements in the docs
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/installation.md | 14 | ||||
| -rw-r--r-- | doc/quickstart.md | 15 |
2 files changed, 23 insertions, 6 deletions
diff --git a/doc/installation.md b/doc/installation.md index a15beb1..8781130 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,21 @@ 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 +% sudo systemctl enable dserver +``` + # 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``: |