Skip to content

Commit e7b0ed4

Browse files
committed
Removing the : from a lot of titles.
I don't think I like them anymore.
1 parent cfc53b9 commit e7b0ed4

31 files changed

+405
-413
lines changed

about/architecture.rst

+12-12
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,28 @@
44
OSSEC Architecture
55
==================
66

7-
Linux and unix-like systems:
8-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7+
Linux and unix-like systems
8+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
99

1010
OSSEC runs as multiple processes, the exact number differing between agent, server, and local installations.
1111
Most processes communicates through unix sockets under the `queue` directory inside of the OSSEC installation location.
1212
When possible the OSSEC processes run with limited privileges and chroot to the install location.
1313
This is modeled after the `Privilege Separation tehniques <https://www.openbsd.org/papers/auug04/mgp00030.html>`_ used in OpenBSD.
1414

15-
Windows:
16-
^^^^^^^^
15+
Windows
16+
^^^^^^^
1717

1818
OSSEC runs as a single service.
1919

20-
Agent/Server Communication:
21-
^^^^^^^^^^^^^^^^^^^^^^^^^^^
20+
Agent/Server Communication
21+
^^^^^^^^^^^^^^^^^^^^^^^^^^
2222

2323
The OSSEC server listens on 1514/udp via `ossec-remoted`.
2424
Agents send messages to the server via `ossec-agentd`.
2525
The communication is two-way, but initiated by the agent.
2626

27-
Agentless and Network Devices:
28-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
27+
Agentless and Network Devices
28+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2929

3030
OSSEC has the ability to communicate with systems that cannot have the agent software installed.
3131
This is typically done through SSH, and a few pre-made `Expect <https://core.tcl.tk/expect/index>`_
@@ -34,8 +34,8 @@ scripts are provided for a number of systems.
3434
In addition to the agentless support, OSSEC can receive syslog messages from any number of devices and process them as if the
3535
messages were delivered via an agent.
3636

37-
User List:
38-
^^^^^^^^^^
37+
User List
38+
^^^^^^^^^
3939

4040
+--------+---------------------------------------------------+
4141
| User | Process |
@@ -49,8 +49,8 @@ User List:
4949
| ossecm | ossec-maild, ossec-csyslogd |
5050
+--------+---------------------------------------------------+
5151

52-
Process List:
53-
^^^^^^^^^^^^^
52+
Process List
53+
^^^^^^^^^^^^
5454

5555
+--------------------+--------------------------------------------------------------------------------+---------------------+
5656
| Process | Description | Install Type |

about/supported.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Supported Systems
55
=================
66

77

8-
Operating Systems:
9-
^^^^^^^^^^^^^^^^^^
8+
Operating Systems
9+
^^^^^^^^^^^^^^^^^
1010

1111
The following operating systems are supported by the OSSEC agent:
1212

@@ -21,8 +21,8 @@ The following operating systems are supported by the OSSEC agent:
2121
- Mac OS X 10.x
2222
- HP-UX 11
2323

24-
Devices Supported via Syslog:
25-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
24+
Devices Supported via syslog
25+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2626

2727
These systems/devices are also supported via remote syslog:
2828

@@ -50,8 +50,8 @@ Using OSSEC agentless options, the following systems are also supported (for log
5050
- Checkpoint firewall (all versions)
5151
- All operating systems specified in the “operating systems” section
5252

53-
Notes about support:
54-
^^^^^^^^^^^^^^^^^^^^
53+
Notes about support
54+
^^^^^^^^^^^^^^^^^^^
5555

5656
The OSSEC project is made up of volunteers, mostly working on the project in their free time.
5757
Some systems will be harder to support due to availability.

configuration/active-response.trst

+18-18
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
.. _active-response_disabled:
44

5-
disabled:
6-
^^^^^^^^^
5+
disabled
6+
^^^^^^^^
77

88
Disables active response if set to `yes`.
99
Active response defaults to enabled on Unix-like systems and disabled on Windows.
@@ -12,15 +12,15 @@ disabled:
1212

1313
.. _active-response_command:
1414

15-
command:
16-
^^^^^^^^
15+
command
16+
^^^^^^^
1717

1818
Specifies the command to be run when the active response is triggered.
1919

2020
.. _active-response_location:
2121

22-
location:
23-
^^^^^^^^^
22+
location
23+
^^^^^^^^
2424

2525
Specifies where the active response will be run.
2626

@@ -36,46 +36,46 @@ location:
3636

3737
.. _active-response_agent_id:
3838

39-
agent_id:
40-
^^^^^^^^^
39+
agent_id
40+
^^^^^^^^
4141

4242
Specifies the agent ID to run the active response on when using `defined-agent` as the `location`.
4343

4444
.. _active-response_level:
4545

46-
level:
47-
^^^^^^
46+
level
47+
^^^^^
4848

4949
The active response will be executed on any event of the specified level or higher.
5050

5151
.. _active-response_rules_group:
5252

53-
rules_group:
54-
^^^^^^^^^^^^
53+
rules_group
54+
^^^^^^^^^^^
5555

5656
The active response will be executed on any alert with the specified group.
5757
Multiple groups can be defined, separated with the pipe (`|`) character.
5858

5959
.. _active-response_rules_id:
6060

61-
rules_id:
62-
^^^^^^^^^
61+
rules_id
62+
^^^^^^^^
6363

6464
The active response will be executed on any alert with the specified rule ID.
6565
Multiple IDs can be specified separated by a comma.
6666

6767
.. _active-response_timeout:
6868

69-
timeout:
70-
^^^^^^^^
69+
timeout
70+
^^^^^^^
7171

7272
Specifies the amount of time, in seconds, before an active response will attempt to reverse its actions.
7373
For example IPs can be unblocked or entries removed from the `hosts.deny` file.
7474

7575
.. _active-response_repeated_offenders:
7676

77-
repeated_offenders:
78-
^^^^^^^^^^^^^^^^^^^
77+
repeated_offenders
78+
^^^^^^^^^^^^^^^^^^
7979

8080
A comma separated list or increasing timeouts (in minutes) for repeat offenders.
8181
There can be a maximum of 5 entries.

configuration/agent_conf.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ The `agent.conf` file (and the contents of `/var/ossec/etc/shared`) will be push
1515
Many of the configuration options in the `ossec.conf` can be placed in teh agent.conf.
1616
If the `agent.conf` is modified, the agent will have to be restarted for the changes to take effect.
1717

18-
Minimal ossec.conf:
19-
^^^^^^^^^^^^^^^^^^^
18+
Minimal ossec.conf
19+
^^^^^^^^^^^^^^^^^^
2020

2121
At a minimum, the `<client>` section is necessary.
2222
Without this, the agent does not know how to communicate with the server.
@@ -30,8 +30,8 @@ Minimal `ossec.conf` example:
3030
<server-hostname>ossec.example.com</server-hostname>
3131
</client>
3232
33-
Settings that will not work:
34-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33+
Settings that will not work
34+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
3535

3636
By default the OSSEC agent will not run commands from an `agent.conf`.
3737
Any `<localfile>` options that require `command` or `full_command` should be configured in the agent's `ossec.conf.`

configuration/agentless.trst

+10-10
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
.. _agentless_type:
44

5-
type:
6-
^^^^^
5+
type
6+
^^^^
77

88
The type of check to be run on the agentless system.
99

@@ -19,15 +19,15 @@ type:
1919

2020
.. _agentless_frequency:
2121

22-
frequency:
23-
^^^^^^^^^^
22+
frequency
23+
^^^^^^^^^
2424

2525
Specifies the time in seconds between each check.
2626

2727
.. _agentless_host:
2828

29-
host:
30-
^^^^^
29+
host
30+
^^^^
3131

3232
Specifies the username and host to be checked.
3333

@@ -39,8 +39,8 @@ host:
3939

4040
.. _agentless_state:
4141

42-
state:
43-
^^^^^^
42+
state
43+
^^^^^
4444

4545
Specifies whether the checks are periodic or periodic_diff.
4646

@@ -52,8 +52,8 @@ state:
5252

5353
.. _agentless_arguments:
5454

55-
arguments:
56-
^^^^^^^^^^
55+
arguments
56+
^^^^^^^^^
5757

5858
Specifies the arguments passed to the script.
5959

configuration/alerts.trst

+6-8
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
.. _alerts_email_alert_level:
44

5-
email_alert_level:
6-
^^^^^^^^^^^^^^^^^^
5+
email_alert_level
6+
^^^^^^^^^^^^^^^^^
77

88
Minimum alert level for email notification.
99

@@ -19,8 +19,8 @@ email_alert_level:
1919

2020
.. _alerts_log_alert_level:
2121

22-
log_alert_level:
23-
^^^^^^^^^^^^^^^^
22+
log_alert_level
23+
^^^^^^^^^^^^^^^
2424

2525
Minimum alert level to record an alert in `alerts.log`.
2626

@@ -30,14 +30,12 @@ log_alert_level:
3030

3131
.. _alerts_use_geoip:
3232

33-
use_geoip:
34-
^^^^^^^^^^
33+
use_geoip
34+
^^^^^^^^^
3535

3636
Enable or disable GeoIP lookups.
3737

3838
**Default:** no
3939

4040
**Allowed:** yes/no
4141

42-
43-

configuration/client.trst

+12-12
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,26 @@
22

33
.. _client_server-ip:
44

5-
server-ip:
6-
^^^^^^^^^^
5+
server-ip
6+
^^^^^^^^^
77

88
Specifies the IP address of the OSSEC management server.
99

1010
**Allowed:** Any valid IP address
1111

1212
.. _client_server-hostname:
1313

14-
server-hostname:
15-
^^^^^^^^^^^^^^^^
14+
server-hostname
15+
^^^^^^^^^^^^^^^
1616

1717
Specifies the hostname of the OSSEC management server.
1818

1919
**Allowed:** Any valid hostname
2020

2121
.. _client_port:
2222

23-
port:
24-
^^^^^
23+
port
24+
^^^^
2525

2626
Specifies the port used by the OSSEC management server.
2727

@@ -31,8 +31,8 @@ port:
3131

3232
.. _client_config-profile:
3333

34-
config-profile:
35-
^^^^^^^^^^^^^^^
34+
config-profile
35+
^^^^^^^^^^^^^^
3636

3737
Specifies the profile to be used by the agent.
3838
The profiles are defined in the `agent.conf` on the OSSEC management server.
@@ -42,8 +42,8 @@ config-profile:
4242

4343
.. _client_notify_time:
4444

45-
notify_time:
46-
^^^^^^^^^^^^
45+
notify_time
46+
^^^^^^^^^^^
4747

4848
Specifies the time in seconds between messages sent to the OSSEC management server.
4949

@@ -54,8 +54,8 @@ notify_time:
5454

5555
.. _client_time-reconnect:
5656

57-
time-reconnect:
58-
^^^^^^^^^^^^^^^
57+
time-reconnect
58+
^^^^^^^^^^^^^^
5959

6060
Time in seconds until a reconnection attempt is made.
6161
This should be set to a number greater than `notify_time`.

0 commit comments

Comments
 (0)