Etherpad

by Waterloo

GitHub Readme.md

etherpad-lite for heroku

This is a wrapper of etherpad-lite for Heroku, incorporating the official release from upstream as a submodule. (This will hopefully make it easier to keep current.)

quickstart

  1. Set up a Heroku account and configure an app with DB of your choice (default MySQL)
  2. Clone this repo into a directory of your choice
  3. Set two Heroku config vars:
heroku config:add DATABASE_URL=urlfromDBprovider
heroku config:add ETHERPAD_SETTINGS=settingsJSONinroot.json
  1. Copy settings.json.template to the filename you gave for ETHERPAD_SETTINGS and tweak as needed
  2. Add your Heroku app as a remote
  3. git push heroku master

plugin support

Just add the plugin to package.json as a dependency.

preparse.rb will copy all ep-starting packages to the etherpad plugins. Using the admin/plugins UI adds the plugin but it will reset in dyno restart

additional settings

Etherpad will complain if you run it as root. If you wish to allow it to run as root, set an additional config variable:

heroku config:add ETHERPAD_ALLOW_ROOT=1

To enable Etherpad's authentication features, set "requireSession" and "editOnly" to "true" in settings.conf. Also set your own API key :

heroku config:add ETHERPAD_API_KEY=somereallylongrandomstring

TODO

  • node_modules versioning/locating
  • Launch script cleanup

(I welcome pull requests for any of these.)

due credit

I had to rewrite the launch script on my own, but once I started to understand it, I incorporated lines from a previous repository.

I got the idea to deconfigure IP/port binding from the cloudfoundry etherapp repo, which was giving me headache for a little while.