Loghound is an open-source, MIT-licensed traffic analyser for Apache, nginx and Caddy access logs. You run it on your own machine; it keeps what it learns in two Opensolr indexes it provisions for you. This is the complete documentation for it.
New here? Two pages and you will know whether you want it.
What Loghound is says what it does and, just as importantly, what it refuses to do. The three-plane model is the idea the whole product is built on.
In seven languages
The panel, the installer and the sign-in page ship in English, Română, Français, Deutsch, Español, 中文 and 日本語, and any wording can be changed on your own installation. Languages shows how.
01 · The shortest path to a working install
- Check the requirements. PHP 8.1 with five extensions, systemd, read access to your logs, and a free Opensolr account.
- Run the installer — from a shell, or prepare the machine and finish in a browser.
- Let it provision the two indexes, or join a pair your account already holds.
- Confirm the log source and its format, and consider the recommended LogFormat.
- Add the beacon to your site. Without it, two of the three planes still work, but neither of the reasons this product exists is at full strength.
02 · Beyond this documentation
- github.com/phpcip/loghound — the source, the issue tracker and the releases. The repository also carries
SPEC.md, which is the binding technical specification the software is written against. - opensolr.com/loghound — the product overview, if you are still deciding.
- The Opensolr platform documentation — for the account, the control panel and the indexes themselves, which Loghound sits on top of.
- Security problems go by email with
LOGHOUND SECURITYin the subject line, never into a public issue. The security model has the address and what to expect.