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 - An LDAP server
  17 - Birthday reminder files (``.bdf``)
  18
  19 Output formats
  20 ==============
  21 - ASCII table
  22 - HTML
  23 - Email (text + HTML parts)
  24
  25
  26 =============
  27 Configuration
  28 =============
  29 Copy ``data/bdrem.config.php.dist`` to ``data/bdrem.config.php`` and
  30 adjust it to your liking.
  31
  32
  33 MS SQL server
  34 =============
  35 Configure the date format in ``/etc/freetds/locales.conf``::
  36
  37     [default]
  38         date format = %Y-%m-%d
  39
  40 Also set the charset to UTF-8 in ``/etc/freetds/freetds.conf``::
  41
  42     [global]
  43         # TDS protocol version
  44         tds version = 8.0
  45         client charset = UTF-8
  46
  47 Restart Apache afterwards.
  48
  49 Use ``dblib`` in the DSN::
  50
  51     dblib:host=192.168.1.1;dbname=Databasename
  52
  53
  54 ============
  55 Dependencies
  56 ============
  57 - PHP 5.3 or higher
  58 - PDO
  59 - PEAR packages:
  60
  61   - Console_CommandLine
  62   - Mail
  63   - Mail_mime
  64   - Console_Table
  65   - Net_LDAP2
  66
  67
  68 =======
  69 License
  70 =======
  71 ``bdrem`` is licensed under the `AGPL v3`__ or later.
  72
  73 __ http://www.gnu.org/licenses/agpl.html
  74
  75
  76 ======
  77 Author
  78 ======
  79 Written by Christian Weiske, cweiske@cweiske.de