matomo-org / matomo-log-analytics

Import any kind of server logs in Matomo for powerful log analytics. Universal log file parsing and reporting.
https://matomo.org/log-analytics/
GNU General Public License v3.0
224 stars 118 forks source link

The Information in this readme might be better served from a wiki to make it more organized. #331

Open Jieiku opened 2 years ago

Jieiku commented 2 years ago

The Information in this readme might be better served from a wiki to make it more organized.

The opening / first page of the wiki could be a table of contents:

Rsyslog:

syslog-ng:

I have been implementing Matomo and Nginx Webserver(s) on Different Machines (centralized rsyslog) Direct/Instant update. and I just about have everything working.

There was a LOT of good information in this readme, but it also assumes a bit of knowledge with rsyslog and in my opinion it would be better to write the instructions in a simple easy to follow step1, step2, step3, etc and assume the user has no experience with rsyslog, I have a bit of experience with rsyslog but I still ran into some trouble on a couple things.

This readme page is huge and while you could technically put a table of contents at the top of it and navigate it, I would think it would be better to split it into pages.

This way if I know I am going to use Nginx, and I know I am going to use rsyslog, then I do not need to see information related to syslog-ng or Apache, or vice versa.

I would be happy to help with the page relevant to my implementation, I can also just update the readme.... but my notes that I have kept as I worked through this are written in a simple easy to follow step1, step2, step3, and im not sure how I would work that into the readme without simply just tacking it onto the bottom of the readme (which is why I suggested separate pages depending on environment and software used)