Skip to content
This repository
branch: master
file 86 lines (57 sloc) 2.906 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
INSTALLATION INSTRUCTIONS

OPTION #1. INSTALLING ON POSIX COMPATIBLE SYSTEMS

* Install the dependencies: Scala 2.7, Sun Java JDK 6 or OpenJDK 6, libmysql-java

* Uninstall gcj if it's installed as it seems to interfere with the
  Scala compiler. You can safely reinstall it after compiling Etherpad
  if you want to.

* You might want to edit the file bin/exports.sh (and optionally
  etherpad/bin/etherpad.default) and change the paths to match your system
  but important paths are already autodetected.

* Run bin/build.sh

* Create a new user on your system called "etherpad"

* Create a MySQL database "etherpad" and a database user "etherpad"

* Copy etherpad/etc/etherpad.localdev-default.properties to etherpad/etc/etherpad.local.properties
* Edit etherpad/etc/etherpad.local.properties and set
   etherpad.SQL_JDBC_URL
       Example etherpad.SQL_JDBC_URL = jdbc:mysql://localhost:3306/etherpad
   etherpad.SQL_PASSWORD
   etherpad.SQL_USERNAME = etherpad
   etherpad.adminPass
   topdomains
       Example: topdomains = yourhostname.com,localhost

* You can now run etherpad via bin/run.sh

* If you want to have Etherpad run via init, create a link
  to debian/etherpad.init from /etc/init.d/etherpad and
  enable via update-rc.d etherpad defaults ; you'll also
  need to create an etherpad user and group via
  groupadd etherpad && useradd -G etherpad etherpad

* You can then start etherpad with run /etc/init.d/etherpad start

OPTION #2: BUILDING THE .DEB PACKAGE

  sudo apt-get install po-debconf debhelper dbconfig-common sun-java6-jdk mysql-client libmysql-java scala scala-library

  debuild -us -uc

As an alternative to debuild you can run

  git-buildpackage -us -uc

if you cloned the git repository (debuild will work also, but git-buildpackage
does some extra sanity checks). In the end you will have a file called
etherpad*.deb in the directory one level above your current directory.

* install the .deb package

  cd ..
  sudo dpkg -i etherpad*.deb

* To run it, do etc/init.d/etherpad start

OPTION #3. INSTALLING ON WINDOWS SYSTEMS WITH CYGWIN

* Install the dependencies in paths that do not contain spaces: cygwin, Scala 2.7, Sun Java JDK 6 or OpenJDK 6, libmysql-java

* Uninstall gcj if it's installed as it seems to interfere with the
  Scala compiler. You can safely reinstall it after compiling Etherpad
  if you want to.

* Run bin/build.sh

* Create a MySQL database "etherpad" and a database user "etherpad"

* Copy etherpad/etc/etherpad.localdev-default.properties to etherpad/etc/etherpad.local.properties

* Edit etherpad/etc/etherpad.local.properties and set
   etherpad.SQL_JDBC_URL
       Example etherpad.SQL_JDBC_URL = jdbc:mysql://localhost:3306/etherpad
   etherpad.SQL_PASSWORD
   etherpad.SQL_USERNAME = etherpad
   etherpad.adminPass
   topdomains
       Example: topdomains = yourhostname.com,localhost

* You can now run etherpad via bin/run.sh
Something went wrong with that request. Please try again.