Skip to content

Latest commit

 

History

History
62 lines (33 loc) · 2.57 KB

readme.md

File metadata and controls

62 lines (33 loc) · 2.57 KB

redmine-digest

What is it?

It generates and sends email digests about Redmine issues that meet the given criteria (SQL query).

It queries the data to be reported directly from the database so it doesn't bloat your Redmine installation, doesn't require new gems nor does it depend on APIs. It only depends on the database schema.

Prerequisites?

The following command-line tools on any OS which has them:

  • sh
  • mkdir
  • rm
  • wc
  • grep
  • curl
  • psql (for PostgreSQL) or sqlite3 (for SQLite)

It is tested and works flawlessly on Windows 8.1 (with Git, pgAdmin and SQLite shell) and on Ubuntu 12.10/13.10.

But I use MySQL/SQL Server!

I don't use them thus I can't test them, so patches are welcome. All it would take is just coding and testing the commands for feeding their corresponding command-line tools with the report queries in query.sh and new_report.sh.

If it's feasible in your setup, you may also try to migrate to PostgreSQL which is a good idea in any case :)

How do I use this?

  • Rename config.sh.example to config.sh and set it up according to your environment.
  • Create a new report config with ./new_report.sh, it should be self-explanatory.
    • If needed, open data/report_name and modify the query (WHERE statement) accordingly.
  • Send the report with ./report.sh report_name [subject].
    • report_name is the name of the report as in the data folder.
    • subject will be added to the email subject if provided. You can use TODAY for the current date and/or YESTERDAY for yesterday's, e.g. Closed Issues on YESTERDAY will be sent as Closed Issues on 2014-01-10.

How do I send daily reports automatically?

Add cronjobs (Unix) or scheduled tasks (Windows). See crontab.example for examples.

Why no release?

Because this is just a bunch of shell scripts. You can safely use the Git version.

More info?

Check out the scripts, they should be straightforward to anyone administering Redmine.

Alternatives?

[ 1 ] [ 2 ] [ 3 ] [ 4 ] [ 5 ]