Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Invalid json error fix and minor improvements in the docs #2

Merged
merged 3 commits into from
Feb 8, 2020
Merged

Invalid json error fix and minor improvements in the docs #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cab409a
fix json
snonux Feb 8, 2020
ae6e9b5
improve documentation
snonux Feb 8, 2020
e2896cf
add enable
snonux Feb 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions doc/installation.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"Users": {
"pbuetow": [
"readfiles:^/.*$"
"readfiles:^/.*$",
"runcommands:^/.*$"
],
"jblake": [
Expand Down