Quick Start

Requirements

Host server with the following installed software:

Step-By-Step

1. Download Kibanalytics Code Repository

git clone https://github.com/kibanalytics/kibanalytics.git
cd kibanalytics

2. Copy Default Configuration Files

By default, all CORS origins are allowed to call Kibanalytics back-end server.

cp .env.example .env
cp -r .config.example .config

WARNING

It's recomended to change the EXPRESS_SESSION_SECRET, ELASTICSEARCH_PASSWORD environment variables default values and set to 'true' ELASTICSEARCH_SECURITY before running Kibanalytics in production.

3. Start Docker Services

docker-compose --profile local --profile production up -d --build

4. Load Default Dashboards

docker-compose exec node npm run load-dashboards

5. Add Front-End Tracking Library

Remember to change the server URL according to your server hostname / domain if you're not running on localhost.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>My Website To Track</title>
    <script src="http://localhost:3000/kbs.js" 
            data-server-url="http://localhost:3000/collect">
    </script>
    ...
</head>
<body>
    <h1>My Website Header</h1>
    <main>My Website Main Content</main>
...
</body>
</html>

Alternatively you can access http://localhost:3000open in new window to interact with some example pages.

6. Open Example Dashboard

Accessing http://localhost:5601/app/dashboardsopen in new window.

By default, security is disabled for Kibana access.