diff options
| author | Paul Buetow <paul@buetow.org> | 2020-01-21 22:19:48 +0000 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2020-01-21 22:19:48 +0000 |
| commit | 1f99be2f54305012a28621f17c941f389834f223 (patch) | |
| tree | 5e4fdde0daf131690bd98147e30288ca9abfd942 /doc | |
| parent | e56c31af93c5432eab8c129e19d8741db1e19a32 (diff) | |
update docs to use go get... in the quick starting guide
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/installation.md | 4 | ||||
| -rw-r--r-- | doc/quickstart.md | 17 |
2 files changed, 9 insertions, 12 deletions
diff --git a/doc/installation.md b/doc/installation.md index d1ecf9f..e9c6d47 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -5,11 +5,9 @@ The following installation guide has been tested successfully on CentOS 7. You m This guide also assumes that you know how to use ``systemd`` and how to configure a service there. If you are unsure please consult the documentation of your distribution. -This guide also assumes that you know how to add a new Nagios check to your monitoring infrastructure. - # Compile it -Please check the [Quick Starting Guide](quickstart.md) for instructions how to compile DTail. It is recommended to automate the build process via your build pipeline (e.g. produce a deployable RPM via Jenkins). But that is out of scope of this documentation. +Please check the [Quick Starting Guide](quickstart.md) for instructions how to compile DTail. It is recommended to automate the build process via your build pipeline (e.g. produce a deployable RPM via Jenkins). You don't have to use ``go get...`` to compile and install the binaries. You can also clone the repository and use ``make`` instead. # Install it diff --git a/doc/quickstart.md b/doc/quickstart.md index daaca35..e7ca4b8 100644 --- a/doc/quickstart.md +++ b/doc/quickstart.md @@ -9,24 +9,23 @@ This guide also assumes that you know how to install and use a Go compiler and G # Compile it -To produce all DTail binaries run ``make``: +To install all DTail binaries from github run: ```console -workstation01 ~/git/dtail % make -go build -o dtail ./cmd/dtail/main.go -go build -o dcat ./cmd/dcat/main.go -go build -o dgrep ./cmd/dgrep/main.go -go build -o dmap ./cmd/dmap/main.go -go build -o dserver ./cmd/dserver/main.go +workstatoin01 ~ % go get github.com/mimecast/dtail/cmd/dtail +workstatoin01 ~ % go get github.com/mimecast/dtail/cmd/dcat +workstatoin01 ~ % go get github.com/mimecast/dtail/cmd/dgrep +workstatoin01 ~ % go get github.com/mimecast/dtail/cmd/dmap +workstatoin01 ~ % go get github.com/mimecast/dtail/cmd/dserver ``` -It produces the following executables: +It produces the following executables in ``$GOPATH/bin``: -* ``dserver``: The DTail server * ``dtail``: Client for tailing/following log files remotely (distributed tail) * ``dcat``: Client for displaying whole files remotely (distributed cat) * ``dgrep``: Client for searching whole files files remotely using a regex (distributed grep) * ``dmap``: Client for executing distributed mapreduce queries (may will consume a lot of RAM and CPU) +* ``dserver``: The DTail server # Start DTail server |