MySQL realated stuff documented.
[mediadatabase.git] / INSTALL
blob9ec510cf21d47c75dee4b00cf2f9397d16cab5f1
1 MDB Installation Notes for FC3 (Draft)
3 0. Requirements:
4    The following packages are needed in order to compile MediaDatabase on your Linux box. All 
5    packages are available in RPMs, so there should not be problem installing them.
7         1. GTK >= 2.6
8         2. libglade - 
9         3. The Configuration File Library (CFL) which could be found here http://www.nongnu.org/cfl/
10         4. GDSL - CFL needs GDSL library to work. GDSL could be found on http://www.nongnu.org/gdsl/
11         5. mysql-devel package
12         6. sqlite and sqlite-devel 
14    MySQL-devel and SQLite packages are available for Fedora Core 3.
16 1. Installation:
17    1.1 Setting up configuration file.
18       Copy the sample file from the src/ directory to your home folder.
20       Example:     cp sample.conf ~/.mediadatabase
22     1.2 Setting up SQLite database
23       To create the file execute: 
24             sqlite /home/user/.media.db
26       To create the database
27             sqlite /home/lordross/.media.db < sql/mediadatabase-empty.sqlite
29    1.3 Setting up MySQL database
30       1.3.1 Prerequisites. MySQL server running and accepting network requests.
31       1.3.2 Create empty tables by executing:
32             mysql -h your_host -u your_username -p < sql/mediadatabase-empty.mysql
34 2. Configuration
35    2.1 The config file   
36         To fully run MDB you need to edit the configuration file for your user (see 1.1). The configuration will
37         be made from the file until the GTK configuration frontend is ready.
39         First you need to setup the mount, unmount and mount point options. Only one CD/DVD drive is
40         currently supported. They look like this:
42         mount = "/bin/mount /media/cdrecorder"
43         unmount = "/bin/umount /media/cdrecorder"
44         mountdir = "/media/cdrecorder"
46         Then you need to setup the database frontend. Uncomment the database you want to use:
48               # Which backend to use
49               backend = "SQLite"
50               #backend = "MySQL"
52         For the SQLite database backend you need to properly setup the following lines. 
54              [SQLite]
55              dbfile = "/home/lordross/.media.db"
57         Note the full path for dbfile. Something like ~/.media.db will not work.
59         The dbfile is the file you created in 1.2.
61         For the MySQL database backend you need to properly setup the following lines. 
63              [MySQL]
64              host = "mysqlserver.domain.org"
65              user = "mediadatabase"
66              pass = "password_for_user_mediadatabase"
67              db = "mediadatabase"
69         Config file can also be changed from the GTK frontend.
71 3. Running
74 KNOWN ISSUES
76 1. GTK+ frontend currently only searches .png files in the directory where it resides.
77 2. MDB currently does not support adding AudioCDs.
78 3. On OpenBSD 3.5, building with gcc 3.3.2 fails in the sqlite header but building with 2.95.3 succeeds.