ackee-report

ackee-report

CLI tool to generate performance reports of websites using the self-hosted analytics tool Ackee.

👋 Introduction

ackee-report lets you create monthly website performance reports using your Ackee analytics data and deliver them to multiple recipients via email. It uses Ackee's Graphql API and can be configured to send multiple reports for different websites and recipients.

🚀 Get started

Install ackee-report via npm:

npm install ackee-report

On the first run ackee-report will ask you to input a few values:

• Ackee server - The endpoint of your Ackee instance
• Ackee username - Your Ackee username you use to login to the UI
• Ackee password - Your Ackee password you use to login to the UI
• SMTP host - more info here
• SMTP port - more info here
• SMTP username - more info here
• SMTP password - more info here
• SMTP from - more info here

The configuration will be stored in your home directory: ~/.config/configstore/ackee-report.json

📚 Usage

Usage: ackee-report generate [options]

Generates report and sends it via specified service

Options:
  -d, --domain <titles...>  specify domains by title
  -i, --id <ids...>         specify domains by id
  -t, --to <recipient...>   to whom the report should be sent (when using email)
  -o, --output <file>       path to output file (when using json)
  -s, --service <name>      service to use (default: "email")
  -h, --help                display help for command

🛠️ Examples

Run:

ackee-report generate -d example.com -t [e-mail]

to generate a report for the domain example.com and send it via email to [e-mail].

To do this every month, create a cron job:

0 0 1 * * ackee-report generate -d example.com -t [e-mail] >> /tmp/ackee-report.log 2>&1

You can also specify mulitple domains and recipients:

ackee-report generate -d example.com example2.com -t [e-mail] [e-mail]

To send multiple reports to different people, add them all as seperate cron jobs.

You can also save the report in a JSON file instead of sending it via email:

ackee-report generate -s json -d example.com -o report.json

⚙️ Configuration

Email

If you want to send your report via email, you have to specify your email providers SMTP server and credentials, aswell as the from option:

• Host - smtp.example.com
• Port - 465
• Username - [e-mail]
• Password - password
• From - [e-mail] or Ackee <[e-mail]>

Enter the values on the first run of ackee-report or change them later in the config file: ~/.config/configstore/ackee-report.json

Common providers:

Gmail

If you use gmail to send emails, use these values:

• Host - smtp.gmail.com
• Port - 465
• Username - your gmail username (your email address)
• Password - your gmail password or if you have 2FA enabled, an "Application Specific password"

SendGrid

If you use SendGrid to send emails, use these values:

• Host - smtp.sendgrid.net
• Port - 465
• Username - apikey (everyone's username is apiKey)
• Password - your API Key (generate one here)

MailGun

If you use SendGrid to send emails, use these values:

• Host - smtp.mailgun.org
• Port - 465
• Username - [e-mail]
• Password - get your password here

📝 To do

Here is what's currently planned for ackee-report:

• include more data in report
• better design/structure of email report
• more customization of data included in report
• change config file via cli
• add more services (e.g. Telegram)

💻 Development

Issues and PRs are very welcome!

Run yarn lint or npm run lint to use eslint.

Please check out the contributing guide before you start.

This project adheres to Semantic Versioning. To see differences with previous versions refer to the CHANGELOG.

❔ About

This library is an extension to the awesome privacy focused analytics tool Ackee.

Ackee was developed by @electerious, if you want to support him and the development of Ackee visit the Donate section on the Ackee repository.

License

Copyright 2020 Maximilian Schiller

This project is licensed under the MIT License - see the LICENSE file for details.