From cab409a368654e56948a6f82e3beb20925ae4a7d Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Sat, 8 Feb 2020 11:08:53 +0000 Subject: fix json --- samples/dtail.json.sample | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/dtail.json.sample b/samples/dtail.json.sample index 6b713e8..cf2c2c2 100644 --- a/samples/dtail.json.sample +++ b/samples/dtail.json.sample @@ -15,7 +15,7 @@ ], "Users": { "pbuetow": [ - "readfiles:^/.*$" + "readfiles:^/.*$", "runcommands:^/.*$" ], "jblake": [ -- cgit v1.2.3 From ae6e9b57500810fff81fe25b4d3080010327d358 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Sat, 8 Feb 2020 11:18:52 +0000 Subject: improve documentation --- doc/installation.md | 13 +++++++++++++ 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``: -- cgit v1.2.3 From e2896cf8f09fbfa0244c91f75a0e243352f36463 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Sat, 8 Feb 2020 11:23:21 +0000 Subject: add enable --- doc/installation.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/installation.md b/doc/installation.md index 75f93d5..8781130 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -47,6 +47,7 @@ uid=670(dserver) gid=670(dserver) groups=670(dserver) % 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 -- cgit v1.2.3