Skip to content
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

Jump to bottom

Update doc #47

Merged
merged 2 commits into from
Jul 31, 2023
Merged

Update doc #47

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f39e970
Fixed docker-compose command
Lorygold Jul 25, 2023
099cec1
Updated logs structure
Lorygold Jul 25, 2023
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
19 changes: 13 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ After that, there are two ways of running BuffaLogs, depending on your system co
* set the address of the host into the `CERTEGO_ELASTICSEARCH` variable in the `buffalogs.env` file
* launch ` docker-compose up -d` to run the containers
* if you have no hosts with Elasticsearch installed on it, you can run it directly with Buffalogs:
* run `docker-compose -f docker-compose.yml -f docker-compose.elastic.yml up -d` in order to execute all the containers, included Elasticsearch and Kibana
* run `docker-compose -f docker-compose.yaml -f docker-compose.elastic.yaml up -d` in order to execute all the containers, included Elasticsearch and Kibana
* Now elasticsearch and kibana are running on the same host with Buffalogs.

![buffalogs_dashboard_screenshot](https://user-images.githubusercontent.com/33703137/220879987-b6453e9d-0129-45c1-bc26-0542005e8730.png)
Expand All @@ -91,16 +91,23 @@ BuffaLogs is able to analyse logs coming from any source, provided that it compl

```
{
"@timestamp" : <timestamp_isoformat>,
"user": {
"name": <user_name>
},
"event": {
"outcome": <"success" OR "failure">
"outcome": <"success" OR "failure">,
"category" : "authentication"
},
"geoip": {
"latitude": <latitude>,
"longitude": <longitude>,
"country_name": <country_name>
"source" : {
"ip" : <source_ip_address>,
"geo" : {
"country_name" : <source_country_name>,
"location" : {
"lat" : <source_latitude>,
"lon" : <source_longitude>
}
}
},
"user_agent": {
"original": <user_agent>
Expand Down
Loading