README.rst

   1 *********************************
   2 bdrem - Birthday reminder by mail
   3 *********************************
   4 Birthday reminder that sends out e-mails.
   5
   6 It can also generate ASCII tables on your console/shell and normal HTML pages.
   7
   8
   9 ========
  10 Features
  11 ========
  12
  13 Data sources
  14 ============
  15 - Any SQL database.
  16
  17   - Multiple date fields per record supported.
  18 - An LDAP server
  19 - `Birthday reminder <http://cweiske.de/birthday3.htm>` files (``.bdf``)
  20
  21 Output formats
  22 ==============
  23 - ASCII table
  24 - HTML
  25 - Email (text + HTML parts)
  26
  27
  28 =============
  29 Configuration
  30 =============
  31 Copy ``data/bdrem.config.php.dist`` to ``data/bdrem.config.php`` and
  32 adjust it to your liking.
  33
  34 When running the ``.phar``, extract the configuration file first::
  35
  36     $ php dist/bdrem-0.1.0.phar config > bdrem-0.1.0.phar.config.php
  37
  38
  39 MS SQL server
  40 =============
  41 Configure the date format in ``/etc/freetds/locales.conf``::
  42
  43     [default]
  44         date format = %Y-%m-%d
  45
  46 Also set the charset to UTF-8 in ``/etc/freetds/freetds.conf``::
  47
  48     [global]
  49         # TDS protocol version
  50         tds version = 8.0
  51         client charset = UTF-8
  52
  53 Restart Apache afterwards.
  54
  55 Use ``dblib`` in the DSN::
  56
  57     dblib:host=192.168.1.1;dbname=Databasename
  58
  59
  60 ============
  61 Dependencies
  62 ============
  63 - PHP 5.3 or higher
  64 - PDO
  65 - PEAR packages:
  66
  67   - Console_CommandLine
  68   - Mail
  69   - Mail_mime
  70   - Console_Table
  71   - Net_LDAP2
  72
  73
  74 =======
  75 License
  76 =======
  77 ``bdrem`` is licensed under the `AGPL v3`__ or later.
  78
  79 __ http://www.gnu.org/licenses/agpl.html
  80
  81
  82 ======
  83 Author
  84 ======
  85 Written by Christian Weiske, cweiske@cweiske.de