securityonion-docs

This repo stores the source code for our documentation which is published by ReadTheDocs at: https://securityonion.net/docs

We use RST format so that ReadTheDocs can publish in both HTML and PDF formats.

Contributing

If you notice any documentation is missing or incorrect, please feel free to submit a pull request (PR) to this repo. We will review the PR and merge if appropriate.

Naming Convention

Our goal is to allow you to easily guess and type the URL of the documentation you want to go to.

For example, if you want to read more about Suricata, you can type the following into your browser: https://securityonion.net/docs/suricata

To achieve this goal, new documentation pages should use the following naming convention:

all lowercase
.rst file extension
ideally, the name of the page should be one simple word (for example: suricata.rst)
try to avoid symbols if possible
if symbols are required, use hyphens (NOT underscores)

Name		Name	Last commit message	Last commit date
Latest commit History 1,406 Commits
images		images
README.md		README.md
about.rst		about.rst
accounts.rst		accounts.rst
adding-accounts.rst		adding-accounts.rst
af-packet.rst		af-packet.rst
airgap.rst		airgap.rst
alert-data-fields.rst		alert-data-fields.rst
alerts.rst		alerts.rst
alienvault-otx.rst		alienvault-otx.rst
analyst-vm.rst		analyst-vm.rst
analyst.rst		analyst.rst
appendix.rst		appendix.rst
apt-cacher-ng.rst		apt-cacher-ng.rst
architecture.rst		architecture.rst
autoruns.rst		autoruns.rst
beats.rst		beats.rst
best-practices.rst		best-practices.rst
bpf.rst		bpf.rst
browser.rst		browser.rst
capme.rst		capme.rst
cheat-sheet.rst		cheat-sheet.rst
cloud-ami.rst		cloud-ami.rst
cloud-client.rst		cloud-client.rst
conf.py		conf.py
conference.rst		conference.rst
connecting-to-sguil.rst		connecting-to-sguil.rst
curator.rst		curator.rst
customizing.rst		customizing.rst
cyberchef.rst		cyberchef.rst
data-fields.rst		data-fields.rst
desktop.rst		desktop.rst
directory.rst		directory.rst
disabling-accounts.rst		disabling-accounts.rst
disabling.rst		disabling.rst
dns-anomaly-detection.rst		dns-anomaly-detection.rst
docker.rst		docker.rst
domainstats.rst		domainstats.rst
download.rst		download.rst
elastalert-fields.rst		elastalert-fields.rst
elastalert.rst		elastalert.rst
elastic-auth.rst		elastic-auth.rst
elastic-features.rst		elastic-features.rst
elastic.rst		elastic.rst
elasticsearch.rst		elasticsearch.rst
elsa-to-elastic.rst		elsa-to-elastic.rst
email.rst		email.rst
eol.rst		eol.rst
etherpad.rst		etherpad.rst
faq.rst		faq.rst
fir.rst		fir.rst
firewall.rst		firewall.rst
freqserver.rst		freqserver.rst
getting-started.rst		getting-started.rst
grr.rst		grr.rst
hardware.rst		hardware.rst
help-wanted.rst		help-wanted.rst
help.rst		help.rst
hive.rst		hive.rst
host.rst		host.rst
hwe.rst		hwe.rst
icmp-anomaly-detection.rst		icmp-anomaly-detection.rst
index.rst		index.rst
installing-on-ubuntu.rst		installing-on-ubuntu.rst
integrations.rst		integrations.rst
introduction.rst		introduction.rst
ip.rst		ip.rst
jq.rst		jq.rst
kibana.rst		kibana.rst
listing-accounts.rst		listing-accounts.rst
local-rules.rst		local-rules.rst
logstash.rst		logstash.rst
mailing-lists.rst		mailing-lists.rst
metapackages.rst		metapackages.rst
misp.rst		misp.rst
mysql-upgrade-errors.rst		mysql-upgrade-errors.rst
mysql.rst		mysql.rst
netsniff-ng.rst		netsniff-ng.rst
network-configuration.rst		network-configuration.rst
network.rst		network.rst
networkminer.rst		networkminer.rst
new-disk.rst		new-disk.rst
nids.rst		nids.rst
ntopng.rst		ntopng.rst
ntp.rst		ntp.rst
passwords.rst		passwords.rst
pcaps.rst		pcaps.rst
performance.rst		performance.rst
pf-ring.rst		pf-ring.rst
post-installation.rst		post-installation.rst
production-deployment.rst		production-deployment.rst
proxy.rst		proxy.rst
quick-iso-image.rst		quick-iso-image.rst
redis.rst		redis.rst
release-notes.rst		release-notes.rst
removing-a-sensor.rst		removing-a-sensor.rst
re‐indexing.rst		re‐indexing.rst
rita.rst		rita.rst
rules.rst		rules.rst
salt.rst		salt.rst

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

securityonion-docs

Contributing

Naming Convention

About

Releases

Packages

Languages

UMWP/securityonion-docs

Folders and files

Latest commit

History

Repository files navigation

securityonion-docs

Contributing

Naming Convention

About

Resources

Security policy

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages