--- /dev/null
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# logparse documentation build configuration file, created by
+# sphinx-quickstart on Sat Aug 31 23:02:08 2019.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc',
+ 'sphinx.ext.doctest',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.todo',
+ 'sphinx.ext.coverage',
+ 'sphinx.ext.ifconfig',
+ 'sphinx.ext.viewcode']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['.templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'logparse'
+copyright = '2019, Andrew Lorimer'
+author = 'Andrew Lorimer'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '2.0'
+# The full version, including alpha/beta/rc tags.
+release = '2.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['.static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+ '**': [
+ 'relations.html', # needs 'show_related': True theme option to display
+ 'searchbox.html',
+ ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'logparsedoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+ # The paper size ('letterpaper' or 'a4paper').
+ #
+ # 'papersize': 'letterpaper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ #
+ # 'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ #
+ # 'preamble': '',
+
+ # Latex figure (float) alignment
+ #
+ # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'logparse.tex', 'logparse Documentation',
+ 'Andrew Lorimer', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'logparse', 'logparse Documentation',
+ [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ (master_doc, 'logparse', 'logparse Documentation',
+ author, 'logparse', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}
--- /dev/null
+.. logparse documentation master file, created by
+ sphinx-quickstart on Sat Aug 31 23:02:08 2019.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+logparse
+====================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+Introduction
+############
+
+Logparse is a simple and extensible log analyser which parses and summaries analyse medium-term server logs (up to around 30 days old). It reports notable events and statistics reported from common server programs. The program is based on a model of independent **parsers** (consisting of Python modules) which analyse logs from a particular service. Logparse comes with a range of these built in, but additional parsers can be written in Python and placed in `/usr/share/logparse/parsers`. At the moment, the default parsers are:
+
++-----------------+-----------------------------------------------------------------------+---------------------------+
+| Parser | Output | Dependencies |
++=================+=======================================================================+===========================+
+| httpd | list requests, clients, user agents, bytes transferred, no. of errors | Apache |
++-----------------+-----------------------------------------------------------------------+---------------------------+
+| cron | number of commands, list commands (root user only) | |
++-----------------+-----------------------------------------------------------------------+---------------------------+
+| cron-journald | number of commands, list commands, list commmands per user | libsystemd |
++-----------------+-----------------------------------------------------------------------+---------------------------+
+| mem | get installed, usable, and free memory | |
++-----------------+-----------------------------------------------------------------------+---------------------------+
+| postfix | list recipients and bytes sent | postfix |
++-----------------+-----------------------------------------------------------------------+---------------------------+
+| smbd | number of logins, list users and clients + samba |
++-----------------+-----------------------------------------------------------------------+---------------------------+
+| sshd | logins by user/hostname, attempted root logins, invalid users | |
++-----------------+ +---------------------------+
+| sshd-journald | | libsystemd |
++-----------------+-----------------------------------------------------------------------+---------------------------+
+| sudo | number of sudo sessions, list users and commands + |
++-----------------+-----------------------------------------------------------------------+---------------------------+
+| sysinfo | hostname, OS, OS version, platform, processor(s) + |
++-----------------+-----------------------------------------------------------------------+---------------------------+
+| temperature | instantaneous temperatures of motherboard, CPU, cores, disks + hddtemp daemon, lmsensors |
++-----------------+-----------------------------------------------------------------------+---------------------------+
+| zfs | zpool scrub reports, disk usage + zfsonlinux + cron job |
++-----------------+-----------------------------------------------------------------------+---------------------------+
+
+Support for further services and custom scripts is planned.
+
+Logparse is also integrated with systemd's `logrotate` to optionally rotate logs only after they have been summarised, and the user may choose to get an email (requires postfix) or a static HTML/plaintext file with the log summary. As an added feature, IP addresses from ssh/samba/apache logs may be resolved to either hostnames or FQDNs.
+
+Configuration is through the file `/etc/logparse.conf`, in yaml format.
+
+Some features require logparse to be run as root (primarily log rotation). It is recommended to set it up on a cron job on a weekly basis.
+
+Indices and tables
+##################
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`