canmove, Confirmed users, Bureaucrats and Sysops emeriti
6,906
edits
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
== Introduction == | == Introduction == | ||
This page | This page contains instructions on how to run Pancake locally on your Mac or Linux machine. Pancake is a somewhat complex application; it consists of a web front-end that talks to multiple independent web services that are part of the back-end. It also depends on two Java based services, Elastic Search and Neo4J. | ||
For use in production mode, there are optional dependencies on MySQL and Redis as data storage, logstash, statsd, graphite and sentry for logging and statistics. | For use in production mode, there are optional dependencies on MySQL and Redis as data storage, logstash, statsd, graphite and sentry for logging and statistics. | ||
We'll do our best to keep it up-to-date, but if this document becomes stale, please ping us on #pancake on irc.mozilla.org | |||
== Requirements == | == Requirements == | ||
| Line 19: | Line 21: | ||
== Installing Elastic Search == | == Installing Elastic Search == | ||
Pancake has been developed with ElasticSearch version 0.19.0, which you can download | Pancake has been developed with ElasticSearch version 0.19.0, which you can download '''[http://www.elasticsearch.org/download/2012/03/01/0.19.0.html here]'''. More recent versions probably work, but are not guaranteed to. | ||
More recent versions probably work, but are not guaranteed to. | |||
After you install ElasticSearch, please add the schema found | After you install ElasticSearch, please add the schema found [https://bitbucket.org/mozillapancake/pancake/src/2b037de0971c/fxhome-lattice/etc/elasticsearch/config here]. | ||
These files will tell ElasticSearch how to index data | These files will tell ElasticSearch how to index data and how it should be retrieved. The default configuration for '''Pancake expects port 9200 for ElasticSearch'''. | ||
== Installing | == Installing Neo4j == | ||
Pancake is using Neo4j 1.7.0. Later versions probably work, but are not guaranteed to. | Pancake is using Neo4j 1.7.0. Later versions probably work, but are not guaranteed to. | ||
You can download Neo4j at http://neo4j.org/download/ | You can download Neo4j at http://neo4j.org/download/ | ||
Set neo4j up to listen on port 7474 and the default configuration should connect to it | Set neo4j up to listen on port 7474 via regular http (non-ssl) and the default configuration should connect to it | ||
== Checking out the Pancake code == | == Checking out the Pancake code == | ||
| Line 39: | Line 40: | ||
hg clone https://bitbucket.org/mozillapancake/pancake | hg clone https://bitbucket.org/mozillapancake/pancake | ||
== | == Setting up a Pancake environment == | ||
Before you can run any of the Pancake code you need to run the following scripts: | Before you can run any of the Pancake code you need to run the following scripts: | ||