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 globally via npm:

npm install ackee-report -g

After that ackee-report is ready to be used 🎉

⚙️ Configuration

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

• ackee server - the endpoint of your Ackee instance
• ackee token - a permanent Ackee token (can be used instead of username and password, more info)
• ackee username - your Ackee username (more info)
• ackee password - your Ackee password (more info)
• email host - the domain of the email server (more info)
• email port - the port of the email server (more info)
• email username - the username to use with the email server (more info)
• email password - the password to use with the email server (more info)
• email from - the from address to use (more info)

The configuration will be stored in your home directory under ~/.config/configstore/ackee-report.json and can be changed at any point.

Ackee API authentication

ackee-report needs access to your Ackee instance via the API in order to get all the data it needs to generate the report. You can choose any of the two authentication methods below:

Username and password:

Enter your username and password you use to login to the Ackee UI on the first run of ackee-report or change it in the config file later.

ackee-report will then use them to create a temporary access token each time it runs and use it to query the Ackee API.

Permanent access token (recommended):

The recommended way of authenticating ackee-report is with a permanent access token (only available with Ackee v2.2.0 or later).

You will have to create one via the Ackee UI under Settings/Permanent Tokens, then click on New permanent token and give it a name (doesn't matter what).

Copy the permanent token id and enter it on the first run of ackee-report or add it to the config file under ackee.token later.

The same token will then be used each time ackee-report runs to query the Ackee API.

Email setup

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]>

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

📚 Usage

Usage: ackee-report email [options]

Generate report and send it via email

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
  -s, --style <name>        email style to use (default: "ackee")
  -h, --help                display help for command

If you want to send the report periodically, you have to setup a cron job which runs the command at a set interval (example below).

🛠️ Examples

Generate a report for one domain and send it via email

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

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

Multiple domains and recipients

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

Send the report periodically (cron)

To send a report periodically, for example every month at the 28th at 23:55 setup a cron job like this:

55 23 28 * * ackee-report email -d example.com -t [e-mail] >> /tmp/ackee-report.log 2>&1

Note: We use the 28th as running on the last day of the month is very complicated with cron and Ackee resets its data on the first day of each month.

Note: You may have to specify the actual path to ackee-report. In that case, replace ackee-report in the command above with the output of which ackee-report.

If you are not familiar with cron, here's a tutorial on how to get started.

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

Output the report to a JSON file

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

ackee-report json -d example.com -o output.json

🖼️ Screenshot

📝 To do

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

• more customization of data included in report
• display data with charts
• 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.

Changelog

[v0.5.0] - 2020-11-01

Added

• you can now use a permanent access token instead of your username and password to autenticate with the Ackee API

Changed

• include data of last 30 days instead of last 7 days
• better error handling
• refactor config validation