Skip to content

Update README.md #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Requirements
---
* Ensure you have http server i.e. Apache with PHP and MYSQL installed and working.
* You will need to have rsyslog storing logs in mysql, so install **rsyslog** and **rsyslog-mysql**
* You will need to have rsyslog storing logs in mysql, so install **rsyslog** and **rsyslog-mysql** and **php-mysql**
* Create a table for syslog entries and user that can SELECT, INSERT, UPDATE, DELETE, FILE for that table only
* Add the following to /etc/rsyslog.conf to enable logs to be stored in mysql
```
Expand All @@ -18,26 +18,44 @@ Installation
`git clone "https://github.com/Tiny-Lama/rsyslog-webui.git" /var/www/html/syslog-ui

* Create the required config from the template
`cp /var/www/html/syslog/config-template.php /var/www/html/syslog/config.php
`cp /var/www/html/syslog-ui/config-template.php /var/www/html/syslog-ui/config.php

* Modify your config file, this is where you will need your mysql database details.
` sudo nano /var/www/html/syslog/config.php
` sudo nano /var/www/html/syslog-ui/config.php

* Create a scheduled task for database clean-up. Open crontab
`sudo crontab -e:

* Modify crontab by pasting this at the end of the file and save (CTRL+O).
```
1 0 * * * cd /var/www/html/maintenance; /usr/bin/php ./db-maintenance.php
1 0 * * * cd /var/www/html/syslog-ui/maintenance; /usr/bin/php ./db-maintenance.php
```

Then test in your web browser:
http://localhost/syslog-ui


Search Bar Examples:
`"Message"="* Login Success *"`
Or more simply:
`"* Login Success *"`
`"*PHP Warning*"`
`*root*`

Date search examples:
`"2025-10-30 12:34:56"`
`"2025-02-31"`
`1969-12-31`
`"Date">"2024-10-30T00:00:00"`


## Mobile:
![Mobile](/images/mobile-screenshot.jpg?raw=true "Mobile")

## Desktop:
![Desktop](/images/screenshot.png?raw=true "Desktop")

[Original Code by hmsdao](https://github.com/hmsdao/bootstrap-rsyslog-ui)

[Improved user Search by xsnidalx]
Now simple and advanced users can search by date YYYY-MM-DD, strings, or wildcard searches using * (asterisk).