Skip to content

Commit

Permalink
Small improvements to OSSEC guide.
Browse files Browse the repository at this point in the history
  • Loading branch information
nathandyer committed May 24, 2024
1 parent a03d422 commit 65af40c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/admin/installation/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,6 @@ on network speed and computing power.
**not** as root. Contact the SecureDrop team if the package
installation encounters repeated errors.

.. _configure_securedrop:

Localization of the *Source Interface* and *Journalist Interface*
-----------------------------------------------------------------

Expand All @@ -52,6 +50,8 @@ parentheses.
French to be available to read the documents and follow up in that
language.

.. _configure_securedrop:

Configure the Installation
--------------------------

Expand Down
14 changes: 8 additions & 6 deletions docs/admin/maintenance/ossec_alerts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,11 @@ the destination address can be [email protected].

What you need:

- The *OSSEC Alert Public Key*
- The fingerprint of the key used when encrypting OSSEC alerts
- The *OSSEC Alert Public Key* and its fingerprint
- The email address that will receive alerts from OSSEC
- The reachable hostname of your SMTP relay
- The secure SMTP port of your SMTP relay
(typically 25, 587, or 465. must support TLS encryption)
(typically 25, 587, or 465; must support TLS encryption)
- An email username to authenticate to the SMTP relay
- The domain name of the email used to send OSSEC alerts
- The password of the email used to send OSSEC alerts
Expand All @@ -56,8 +55,11 @@ solutions should be able to meet those requirements.

These values must be set in the
:ref:`configuration playbook<configure_securedrop>` by running the
``securedrop-admin sdconfig`` command, which will prompt for each of the
items listed above.
``./securedrop-admin sdconfig`` command, which will prompt for each of the
items listed above. Please note, this command updates the configuration,
but does not apply it to the servers. Any time you make changes to
the configuration it is necessary to deploy them with the
``./securedrop-admin install`` command.

If you don't know what value to enter for one of these, please ask your
organization's email admin for the full configuration before
Expand All @@ -82,7 +84,7 @@ although we've described some common scenarios in the

If you have your *OSSEC Alert Public Key* public key handy, copy it to
``install_files/ansible-base`` and then specify the filename, e.g.
``ossec.pub``, when prompted by ``securedrop-admin sdconfig``.
``ossec.pub``, when prompted by ``./securedrop-admin sdconfig``.

If you don't have your GPG key ready, you can run GnuPG on the command line in
order to find, import, and export your public key. It's best to copy the key
Expand Down

0 comments on commit 65af40c

Please sign in to comment.