doc/mysql.txt

   1 =============
   2 MySQL Backend
   3 =============
   4
   5 This notes detail the MySQL backend for the roundup issue tracker.
   6
   7
   8 Prerequisites
   9 =============
  10
  11 To use MySQL as the backend for storing roundup data, you also need
  12 to install:
  13
  14     1. MySQL RDBMS 3.23.34 or higher - http://www.mysql.com. Your MySQL
  15        installation should support Berkeley DB (BDB) tables for transaction
  16        support.
  17     2. Python MySQL interface - http://sourceforge.net/projects/mysql-python
  18
  19
  20 Running the MySQL tests
  21 =======================
  22
  23 Roundup tests expect an empty MySQL database. Two alternate ways to provide
  24 this:
  25
  26     1. If you have root permissions on the MySQL server, you can create
  27        the necessary database entries using this SQL sequence:
  28
  29        CREATE DATABASE rounduptest
  30        GRANT ALL PRIVILEGES ON rounduptest TO rounduptest@localhost IDENTIFIED BY 'rounduptest'
  31        FLUSH PRIVILEGES
  32
  33     2. If your administrator has provided you with database connection info,
  34        you can modify MYSQL_* constants in the file test/test_db.py with
  35        the correct values.
  36
  37 Note that the MySQL database should not contain any tables. Tests will not
  38 drop the database with existing data.
  39
  40
  41 Additional configuration
  42 ========================
  43
  44 To initialise and use the MySQL database backend, roundup's configuration
  45 file (config.py in the tracker's home directory) should have the following
  46 entries:
  47
  48     MYSQL_DBHOST = 'localhost'
  49     MYSQL_DBUSER = 'rounduptest'
  50     MYSQL_DBPASSWORD = 'rounduptest'
  51     MYSQL_DBNAME = 'rounduptest'
  52     MYSQL_DATABASE = ( MYSQL_DBHOST, MYSQL_DBUSER, MYSQL_DBPASSWORD, MYSQL_DBNAME )
  53
  54 Fill in the first four entries with values for your local MySQL installation
  55 before running "roundup-admin initialise".
  56
  57
  58     Andrey Lebedev <andrey@micro.lt>
  59
  60
  61  vim: et tw=80