Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

add INSTALL document

  • Loading branch information...
commit 4ec94aa73b956d6063651fe13ea26300b5cd0a9a 1 parent 16f8801
straup authored
Showing with 52 additions and 0 deletions.
  1. +52 −0 INSTALL.md
View
52 INSTALL.md
@@ -0,0 +1,52 @@
+Installing reverse-geoplanet
+--
+
+reverse-geoplanet is built on top of [Flamework](https://github.com/exflickr/flamework) which means it's nothing more than a vanilla Apache + PHP + MySQL application. You can run it as a dedicated virtual host or as a subdirectory of an existing host.
+
+It uses the Flickr API
+
+You will need to make a copy of the [config.php.example](https://github.com/straup/reverse-geoplanet/blob/master/www/include/config.php.example) file and name it `config.php`. You will need to update this new file and add the various specifics for databases and third-party APIs.
+
+The basics
+===
+
+ # You will need avalid Flickr API key
+ # See also: http://www.flickr.com/services/apps/create/apply/
+
+ $GLOBALS['cfg']['flickr_api_key'] = '';
+
+ # You will need to setup a MySQL database and plug in the specifics
+ # here: https://github.com/straup/reverse-geoplanet/blob/master/schema
+
+ # See also: https://github.com/straup/flamework-tools/blob/master/bin/setup-db.sh
+
+ $GLOBALS['cfg']['db_main'] = array(
+ 'host' => 'localhost',
+ 'name' => 'parallelogram',
+ 'user' => 'parallelogram',
+ 'pass' => '',
+ 'auto_connect' => 1,
+ );
+
+ # If you don't have memcache installed (or don't even know what
+ # that means) just leave this blank. Otherwise change the 'cache_remote_engine'
+ # to 'memcache'.
+
+ $GLOBALS['cfg']['cache_remote_engine'] = '';
+ $GLOBALS['cfg']['memcache_host'] = 'localhost';
+ $GLOBALS['cfg']['memcache_port'] = '11211';
+
+Remaining details
+===
+
+ # This is only relevant if are running parallel-ogram on a machine where you
+ # can not make the www/templates_c folder writeable by the web server. If that's
+ # the case set this to 0 but remember that you'll need to pre-compile all
+ # of your templates before they can be used by the site.
+ # See also: https://github.com/straup/parallel-ogram/blob/master/bin/compile-templates.php
+
+ $GLOBALS['cfg']['smarty_compile'] = 1;
+
+That's it. Or should be. If I've forgotten something please let me know or
+submit a pull request.
+
Please sign in to comment.
Something went wrong with that request. Please try again.