From 5f3e6b8569b5b71853208949506bbcd3c44488b5 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Wed, 13 Oct 2021 20:39:00 +0300 Subject: backport docs from master --- doc/installation.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'doc/installation.md') diff --git a/doc/installation.md b/doc/installation.md index 6bf17b0..8f3892c 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -5,13 +5,13 @@ The following installation guide has been tested successfully on CentOS 7. You m # 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). You don't have to use ``go get...`` to compile and install the binaries. You can also clone the repository and use ``make`` instead. +Please check the [Quick Starting Guide](quickstart.md) for instructions on compiling DTail. It is recommended to automate the build process via your build pipeline (e.g. produce a deployable (.rpm, .deb, ...) 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. ## Linux ACL support -This is optional but it gives you better security. On Linux you have the option to compile `dserver` with File System Access Control List support. For that you need: +This is optional, but it gives you better security. On Linux, you have the option to compile `dserver` with File System Access Control List support. For that, you need: -### 1. Install the `libacl` development library. On RHEL, CentOS and Fedora it would be +### 1. Install the `libacl` development library. On RHEL, CentOS and Fedora, it would be ```console % sudo dnf install libacl-devel -y @@ -25,7 +25,7 @@ Set the `USE_ACL` environment variable before invoking the make command. % export USE_ACL=yes ``` -Alternatively you could just add `-tags linuxacl` to the Go compiler. +Alternatively, you could add `-tags linuxacl` to the Go compiler. # Install it @@ -95,7 +95,7 @@ To start the DTail server via ``systemd`` run: # Register SSH public keys in DTail server -The DTail server now runs as a ``systemd`` service under system user ``dserver``. The system user ``dserver`` however has no permissions to read the SSH public keys from ``/home/USER/.ssh/authorized_keys``. Therefore, no user would be able to establish a SSH session to DTail server. As an alternative path DTail server also checks for public SSH key files in ``/var/run/dserver/cache/USER.authorized_keys``. +The DTail server now runs as a ``systemd`` service under system user ``dserver``. However, the system user ``dserver`` has no permissions to read the SSH public keys from ``/home/USER/.ssh/authorized_keys``. Therefore, no user would be able to establish an SSH session to DTail server. As an alternative path DTail server also checks for public SSH key files in ``/var/run/dserver/cache/USER.authorized_keys``. It is recommended to execute [update_key_cache.sh](../samples/update_key_cache.sh.sample) periodically to update the key cache. In case you manage your public SSH keys via Puppet you could subscribe the script to corresponding module. Or alternatively just configure a cron job or a systemd timer to run every once in a while, e.g. every 30 minutes: @@ -115,11 +115,11 @@ It is recommended to execute [update_key_cache.sh](../samples/update_key_cache.s # Run DTail client -Now you should be able to use DTail client like outlined in the [Quick Starting Guide](quickstart.md). Also have a look at the [Examples](examples.md). +Now you should be able to use DTail client like outlined in the [Quick Starting Guide](quickstart.md). Also, have a look at the [Examples](examples.md). # Monitor it -To verify that DTail server is up and running and functioning as expected you should configure the Nagios check [check_dserver.sh](../samples/check_dserver.sh.sample) in your monitoring system. The check has to be executed locally on the server (e.g. via NRPE). How to configure the monitoring system in detail is out of scope of this guide. +To verify that DTail server is up and running and functioning as expected, you should configure the Nagios check [check_dserver.sh](../samples/check_dserver.sh.sample) in your monitoring system. The check has to be executed locally on the server (e.g. via NRPE). How to configure the monitoring system in detail is out of scope of this guide. ```console % ./check_dserver.sh -- cgit v1.2.3 From 860c41441b3bcf542b5701ae2257812879ce47b4 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Tue, 19 Oct 2021 19:01:12 +0300 Subject: Set DTAIL_RUN_INTEGRATIONT_TEST to yes for integration tests --- doc/installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/installation.md') diff --git a/doc/installation.md b/doc/installation.md index 8f3892c..0f6143b 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 `USE_ACL` environment variable before invoking the make command. +Set the `DTAIL_USE_ACL` environment variable before invoking the make command. ```console -% export USE_ACL=yes +% export DTAIL_USE_ACL=yes ``` Alternatively, you could add `-tags linuxacl` to the Go compiler. -- cgit v1.2.3 From fe010308fdcb07502c0287bdf684b41b1af9c8a6 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Thu, 21 Oct 2021 20:55:44 +0300 Subject: merge doc from master branch --- doc/installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/installation.md') 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. -- cgit v1.2.3 From dadbaab24d66685db0a2a6655bd75cdbb19eb929 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Wed, 27 Oct 2021 10:35:36 +0300 Subject: Update docs to reflect some of the changes made in the past --- doc/installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/installation.md') diff --git a/doc/installation.md b/doc/installation.md index 8f3892c..0f6143b 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 `USE_ACL` environment variable before invoking the make command. +Set the `DTAIL_USE_ACL` environment variable before invoking the make command. ```console -% export USE_ACL=yes +% export DTAIL_USE_ACL=yes ``` Alternatively, you could add `-tags linuxacl` to the Go compiler. -- cgit v1.2.3