diff options
| author | Paul Buetow <pbuetow@mimecast.com> | 2021-10-21 20:55:44 +0300 |
|---|---|---|
| committer | Paul Buetow <pbuetow@mimecast.com> | 2021-10-21 20:55:44 +0300 |
| commit | fe010308fdcb07502c0287bdf684b41b1af9c8a6 (patch) | |
| tree | 935cfebf33e478d1e874cdc77f972e49be3bff5d | |
| parent | 3f5672291c14da1dd3d5699867a286e2d53d26b9 (diff) | |
merge doc from master branch
| -rw-r--r-- | README.md | 22 | ||||
| -rw-r--r-- | doc/installation.md | 4 |
2 files changed, 14 insertions, 12 deletions
@@ -1,24 +1,26 @@ DTail ===== - + -DTail (a distributed tail program) is a DevOps tool for engineers programmed in Google Go for following (tailing), catting and grepping (including gzip and zstd decompression support) log files on many machines concurrently. An advanced feature of DTail is to execute distributed mapreduce aggregations across many machines. +[](https://www.apache.org/licenses/LICENSE-2.0.html) [](https://goreportcard.com/report/github.com/mimecast/dtail) [](https://www.vbrandl.net/post/2019-05-03_hits-of-code/)    -For secure authorization and transport encryption the SSH protocol is used. Furthermore, DTail respects the UNIX file system permission model (traditional on all Linux/UNIX variants and also ACLs on Linux based operating systems). +DTail (a distributed tail program) is a DevOps tool for engineers programmed in Google Go for following (tailing), catting and grepping (including gzip and zstd decompression support) log files on many machines concurrently. An advanced feature of DTail is to execute distributed MapReduce aggregations across many devices. -The DTail binary operate in either client or in server mode. The DTail server must be installed on all server boxes involved. The DTail client (possibly running on a regular Laptop) is used interactively by the user to connect to the servers concurrently. That currently scales to multiple thousands of servers per client. +For secure authorization and transport encryption, the SSH protocol is used. Furthermore, DTail respects the UNIX file system permission model (traditional on all Linux/UNIX variants and also ACLs on Linux based operating systems). + +The DTail binary operates in either client or server mode. The DTail server must be installed on all server boxes involved. The DTail client (possibly running on a regular Laptop) is used interactively to connect to the servers concurrently. That currently scales to multiple thousands of servers per client.  -If you like what you see [look here for more examples](doc/examples.md)! +If you like what you see [look here for more examples](doc/examples.md)! You can also read through the [DTail Mimecast Engineering Blog Post](https://medium.com/mimecast-engineering/dtail-the-distributed-log-tail-program-79b8087904bb). There is also a GitHub Page at [dtail.dev](https://dtail.dev). Installation and Usage ====================== -* For simplest setup please follow the [Quick Starting Guide](doc/quickstart.md). -* For a more sustainable setup please follow the [Installation Guide](doc/installation.md). -* Please also have a look at the [Usage Examples](doc/examples.md). +* For the most straightforward setup, please follow the [Quick Starting Guide](doc/quickstart.md). +* For a more sustainable setup, please follow the [Installation Guide](doc/installation.md). +* Please also look at the [Usage Examples](doc/examples.md). More ==== @@ -31,5 +33,5 @@ Credits ======= * DTail was created by **Paul Buetow** *<pbuetow@mimecast.com>* - -* Thank you to **Vlad-Marian Marian** for creating the DTail logo. +* Thank you to **Vlad-Marian Marian** for creating the DTail (dog) logo. +* The Gopher was generated at https://gopherize.me diff --git a/doc/installation.md b/doc/installation.md index 0f6143b..8f3892c 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -19,10 +19,10 @@ This is optional, but it gives you better security. On Linux, you have the optio ### 2. Enable ACL via a Go build flag -Set the `DTAIL_USE_ACL` environment variable before invoking the make command. +Set the `USE_ACL` environment variable before invoking the make command. ```console -% export DTAIL_USE_ACL=yes +% export USE_ACL=yes ``` Alternatively, you could add `-tags linuxacl` to the Go compiler. |