Allow the API to be taken offline completely as well as being put into

[rails.git] / db / README

diff --git a/db/README b/db/README
index 68fc8e6ceb571b44bb02672a7ffd8bb8612d4285..f4530f09008b3fa2edef36816da7dd4ffb8ae007 100644 (file)
--- a/db/README
+++ b/db/README
@@ -1,9 +1,55 @@
-you want to do something like this
+Creating database
+===================
+
+OSM server uses a database with the following name:
+
+openstreetmap
+
+You may create it with your preferable client or run next (linux) command:
+
+$ mysqladmin -u <uid> -p create openstreetmap
+
+(change <uid> with appropriate username of administrative user eg. root )
+
+Creating user, password, and access rights
+============================================
+
+$ mysql -u <uid> -p
+
+(change <uid> with appropriate username of administrative user eg. root )
 
-$ su
-# mysqladmin create openstreetmap
-# mysql
 > grant all privileges on openstreetmap.* to 'openstreetmap'@'localhost' identified by 'openstreetmap';
+> flush privileges;
+> exit
+
+Creating functions
+====================
+
+Run this command in the db/functions directory:
+
+$ make
+
+Make sure the db/functions directory is on the MySQL server's library
+path and restart the MySQL server. On linux the easiest way to do this
+is to create /etc/ld.so.conf.d/osm.conf and place the path to the
+db/functions directory in it and then run the following command as root:
+
+$ ldconfig
+
+Now create the functions as follows:
+
+$ mysql -u <uid> -p openstreetmap
+
+(change <uid> with appropriate username of administrative user eg. root )
+
+> create function tile_for_point returns integer soname 'libquadtile.so';
 > exit
-# exit
-$ mysql openstreetmap -u openstreetmap -p < db/create_database.sql
+
+Creating database skeleton tables
+===================================
+
+Run this command from the root of your rails directory:
+
+$ rake db:migrate
+
+This will create the db for you