Files
hackpad/INSTALL
Christopher Lin f024292eea [install] Update default values in bin/exports.sh
We also clean up exports.sh a bit so it's easy to tell what needs
customizing for new environments vs. what is supposed to work as-is.
These are hopefully more up-to-date and reasonable defaults for a
developer on OS X, and for developers not on OS X, hopefully the cleanup
helps clarify what likely needs customization.

One of the changes to default values is to use the scala-library.jar
within the given installation of Scala, not the repo's
scala-library.jar.  I don't know much about Scala, but it seems like a
better default to make SCALA, SCALA_HOME, and SCALA_LIBRARY_JAR all
match instead of SCALA_LIBRARY_JAR being a special snowflake that's
checked into the repo.
2015-08-19 15:40:17 -07:00

31 lines
1.0 KiB
Plaintext

INSTALLATION INSTRUCTIONS
INSTALLING ON POSIX COMPATIBLE SYSTEMS
* Install the dependencies:
* Sun Java JDK 7
* Scala 2.11: On OS X, it's easiest to install via [Homebrew](http://brew.sh/): `brew install scala`
* MySQL: Again, easiest to install via Homebrew: `brew install mysql`
* Edit the file bin/exports.sh (and optionally
etherpad/bin/etherpad.default) and change the paths to
match your system.
* Run bin/build.sh
* Run contrib/scripts/setup-mysql-db.sh
* Copy etherpad/etc/etherpad.localdev-default.properties to etherpad/etc/etherpad.local.properties
* Edit etherpad/etc/etherpad.local.properties and set
etherpad.superUserEmailAddresses
Example: etherpad.superUserEmailAddresses = name1@example.com,name2@example.com
topdomains
Example: topdomains = yourhostname.com,localhost
* You can now run etherpad via bin/run.sh
* If you want emoji support go to https://github.com/github/gemoji/tree/master/images/emoji/unicode
and copy the images into etherpad/src/static/img/emoji/unicode/