Skip to content

Commit

Permalink
Merge pull request #2 from snonux/master
Browse files Browse the repository at this point in the history
Invalid json error fix and minor improvements in the docs
  • Loading branch information
pbuetow authored Feb 8, 2020
2 parents f0c01a3 + e2896cf commit 4f20e03
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 7 deletions.
14 changes: 14 additions & 0 deletions doc/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
```
Expand All @@ -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:
Expand Down
15 changes: 9 additions & 6 deletions doc/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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``:
Expand Down
2 changes: 1 addition & 1 deletion samples/dtail.json.sample
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"Users": {
"pbuetow": [
"readfiles:^/.*$"
"readfiles:^/.*$",
"runcommands:^/.*$"
],
"jblake": [
Expand Down

0 comments on commit 4f20e03

Please sign in to comment.