Difference between revisions of "Amarok/Manual/Organization/Collection/ExternalDatabase"

Jump to: navigation, search
m (some additional formatting)
Line 1: Line 1:
[[Category:Amarok]]
+
== Introduction ==
{{Construction}}
 
  
{{Todo|add images (get those from the original article: [http://amarok.kde.org/wiki/MySQL_Server]}}
+
Amarok 2.2 and above support an external '''MySQL''' database as a backend.
  
= Configuration =
+
== Configure Server ==
  
Amarok 2.2 and above support an external MySQL database as a backend.
+
=== Install MySQL-Server ===
  
 +
First you need to install an '''MySQL'''-Server. On Debian-based distributions like Ubuntu you can use
 +
{{Input|1=sudo apt-get install mysql-server}}
 +
to install it. You will be asked to specify a password for the root-account for the database.
  
== MySQL Setup ==
+
=== Configure Database ===
  
On your MySQL server, run a command like:
+
Connect to the local database using
 +
{{Input|1=mysql -u root -p mysql''}}
 +
Then you will get the ''mysql>'' prompt. <br />
 +
Create a new user '''''amarokuser''''' with the password '''''amarokpass''''' using the
 +
{{Input|1=CREATE USER '''<nowiki>'</nowiki>amarokuser<nowiki>'</nowiki>'''@'''<nowiki>'</nowiki>localhost<nowiki>'</nowiki>''' IDENTIFIED BY '''<nowiki>'</nowiki>amarokpass<nowiki>'</nowiki>''';}}
 +
command. Amarok needs its own database, which is created with
 +
{{Input|1=CREATE DATABASE '''amarokdb''';''}}
 +
Give the new user access to the database by entering the
 +
{{Input|1=GRANT ALL ON '''amarokdb'''.* TO '''<nowiki>'</nowiki>amarokuser<nowiki>'</nowiki>'''@'''<nowiki>'</nowiki>%<nowiki>'</nowiki>''' IDENTIFIED BY '''<nowiki>'</nowiki>amarokpass<nowiki>'</nowiki>''';}}
 +
command, where ''%'' is a wildcard to allow all hosts to connect to the database. Now use the
 +
{{Input|1=FLUSH PRIVILEGES;}}
 +
statement to reload various internal caches used by MySQL. Finally
 +
{{Input|1=exit}}
 +
closes the MySQL-prompt.<br />
 +
By default the server can only be accessed by the local host. To change this you need to edit the file ''/etc/mysql/my.cnf'' and adjust the address near ''bind-address'' to the one your server listens on the network. '''0.0.0.0''' listens on all interfaces. After that you need to restart the server using
 +
{{Input|1=sudo service mysql restart}}
  
{{Input|1=
+
== Configure Client ==
GRANT ALL ON amarok.* TO ''amarokuser''@''localhost'' IDENTIFIED BY ''mypassword''; FLUSH PRIVILEGES;
 
}}
 
  
Be sure to substitute for ''amarokdb'', ''amarokuser'', ''localhost'', and ''mypassword'' as appropriate.
+
Open the configuration dialog by clicking <menuchoice>Settings -> Configure Amarok... -> Database</menuchoice>. Enable the checkbox and enter the user data.<br />
 
+
<br />
With newer versions of Amarok you can configure the database from within Amarok at <menuchoice>Settings -> Configure Amarok -> Database</menuchoice>. See the screenshot below.
+
[[File:remotecollections_client.png]]<br />
 
+
<br />
[[Image:Amarok mysql.png]]
+
You need to restart Amarok so that the changes take effect.
 
 
 
 
If you have an older version, you may need to add the database via your amarokrc file, usually in ~/.kde4/share/config/amarokrc.  Add a [MySQL] section:
 
{{Input|1=[MySQL]
 
UseServer=true
 
Database=amarok
 
Host=localhost
 
Password=mypassword
 
User=amarokuser}}
 
  
 
== Migrating from MySQL Embedded to MySQL Server ==
 
== Migrating from MySQL Embedded to MySQL Server ==
  
If you want to maintain the statistics, etc. that you have in the embedded MySQL database from before Amarok 2.2, you can do the following:
+
If you want to maintain the statistics, etc. that you have in the embedded '''MySQL''' database from before '''Amarok''' 2.2, you can do the following:
 +
First, start '''Amarok''' 2.2 at least once to give the database a chance to update to the latest schema version.
  
First, start Amarok 2.2 at least once to give the database a chance to update to the latest schema version.
+
Next, kill the running '''MySQL''' service
 
 
Next, kill the running MySQL service
 
 
{{Input|1=sudo /etc/init.d/mysql stop}}
 
{{Input|1=sudo /etc/init.d/mysql stop}}
and start a MySQL daemon from your ~/.kde4/share/apps/amarok directory (--defaults-file MUST be the first option!):
+
and start a '''MySQL''' daemon from your ''~/.kde4/share/apps/amarok'' directory (--defaults-file MUST be the first option!):
 
{{Input|1=/usr/sbin/mysqld --defaults-file=`pwd`/my.cnf --default-storage-engine=MyISAM --datadir=`pwd`/mysqle --socket=`pwd`/sock --skip-grant-tables}}
 
{{Input|1=/usr/sbin/mysqld --defaults-file=`pwd`/my.cnf --default-storage-engine=MyISAM --datadir=`pwd`/mysqle --socket=`pwd`/sock --skip-grant-tables}}
The skip-grant-tables means you can use any password or username to connect to it. 'localhost' will not work, the MySQL client will try to use a unix socket. Using 127.0.0.1 as the host makes it work. Some systems may restrict this access through apparmor or SELinux. They can be temporarily disabled with  
+
The skip-grant-tables means you can use any password or username to connect to it. 'localhost' will not work, the '''MySQL''' client will try to use a '''Unix''' socket. Using '''127.0.0.1''' as the host makes it work. Some systems may restrict this access through apparmor or SELinux. They can be temporarily disabled with  
 
{{Input|1=sudo /etc/init.d/apparmor stop}}
 
{{Input|1=sudo /etc/init.d/apparmor stop}}
 
 
Now, run mysqldump, passing in the -S option to specify the local socket.  This will dump your old embedded DB out to a SQL file.
 
Now, run mysqldump, passing in the -S option to specify the local socket.  This will dump your old embedded DB out to a SQL file.
 
 
{{Input|1=mysqldump -S sock amarok > amarok.mysql}}
 
{{Input|1=mysqldump -S sock amarok > amarok.mysql}}
 
+
You can then restart your '''MySQL''' service and load this SQL file into your '''MySQL''' server. You'll have needed to already run the GRANT statement above and create an '''Amarok''' database ("CREATE DATABASE amarok;"):
You can then restart your MySQL service and load this SQL file into your mysql server. You'll have needed to already run the GRANT statement above and create an amarok database ("CREATE DATABASE amarok;"):
 
 
 
 
{{Input|1=sudo /etc/init.d/mysql stop
 
{{Input|1=sudo /etc/init.d/mysql stop
 
  mysql -u amarokuser -p amarok < amarok.mysql}}
 
  mysql -u amarokuser -p amarok < amarok.mysql}}

Revision as of 06:14, 18 December 2010

Introduction

Amarok 2.2 and above support an external MySQL database as a backend.

Configure Server

Install MySQL-Server

First you need to install an MySQL-Server. On Debian-based distributions like Ubuntu you can use

sudo apt-get install mysql-server

to install it. You will be asked to specify a password for the root-account for the database.

Configure Database

Connect to the local database using

mysql -u root -p mysql

Then you will get the mysql> prompt.
Create a new user amarokuser with the password amarokpass using the

CREATE USER 'amarokuser'@'localhost' IDENTIFIED BY 'amarokpass';

command. Amarok needs its own database, which is created with

CREATE DATABASE amarokdb;

Give the new user access to the database by entering the

GRANT ALL ON amarokdb.* TO 'amarokuser'@'%' IDENTIFIED BY 'amarokpass';

command, where % is a wildcard to allow all hosts to connect to the database. Now use the

FLUSH PRIVILEGES;

statement to reload various internal caches used by MySQL. Finally

exit

closes the MySQL-prompt.
By default the server can only be accessed by the local host. To change this you need to edit the file /etc/mysql/my.cnf and adjust the address near bind-address to the one your server listens on the network. 0.0.0.0 listens on all interfaces. After that you need to restart the server using

sudo service mysql restart

Configure Client

Open the configuration dialog by clicking Settings -> Configure Amarok... -> Database. Enable the checkbox and enter the user data.

Remotecollections client.png

You need to restart Amarok so that the changes take effect.

Migrating from MySQL Embedded to MySQL Server

If you want to maintain the statistics, etc. that you have in the embedded MySQL database from before Amarok 2.2, you can do the following: First, start Amarok 2.2 at least once to give the database a chance to update to the latest schema version.

Next, kill the running MySQL service

sudo /etc/init.d/mysql stop

and start a MySQL daemon from your ~/.kde4/share/apps/amarok directory (--defaults-file MUST be the first option!):

/usr/sbin/mysqld --defaults-file=`pwd`/my.cnf --default-storage-engine=MyISAM --datadir=`pwd`/mysqle --socket=`pwd`/sock --skip-grant-tables

The skip-grant-tables means you can use any password or username to connect to it. 'localhost' will not work, the MySQL client will try to use a Unix socket. Using 127.0.0.1 as the host makes it work. Some systems may restrict this access through apparmor or SELinux. They can be temporarily disabled with

sudo /etc/init.d/apparmor stop

Now, run mysqldump, passing in the -S option to specify the local socket. This will dump your old embedded DB out to a SQL file.

mysqldump -S sock amarok > amarok.mysql

You can then restart your MySQL service and load this SQL file into your MySQL server. You'll have needed to already run the GRANT statement above and create an Amarok database ("CREATE DATABASE amarok;"):

sudo /etc/init.d/mysql stop
 mysql -u amarokuser -p amarok < amarok.mysql
Note-box-icon.png
Note
You may need to re-scan your collection in Amarok after completing this.



Content is available under Creative Commons License SA 4.0 unless otherwise noted.