Etherpad Lite

From Wikitech
Jump to: navigation, search

From Etherpad

Installing

Source is available here: https://github.com/Pita/etherpad-lite

Installed apache2 with puppet, class misc::apache2.

Install nodejs and npm

git-core was installed but once etherpadlite gets packaged we won't need that.

Installed the dependcies: curl python libssl-dev build-essential

Git clone'd to /srv

git clone https://github.com/Pita/etherpad-lite.git

Install the dependencies with bin/installDeps.sh

Add an etherpad-lite user

sudo adduser --system --home /srv/etherpad-lite --group etherpad-lite
sudo addgroup 

Create log folder in /var/log/etherpad-lite, making sure the the user has access to it

Create the init script

#!/bin/sh

### BEGIN INIT INFO
# Provides:          etherpad-lite
# Required-Start:    $local_fs $remote_fs $network $syslog
# Required-Stop:     $local_fs $remote_fs $network $syslog
# Default-Start:     2 3 4 5
# Default-Stop:      0 1 6
# Short-Description: starts etherpad lite
# Description:       starts etherpad lite using start-stop-daemon
### END INIT INFO

PATH="/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin"
LOGFILE="/var/log/etherpad-lite/etherpad-lite.log"
EPLITE_DIR="/srv/etherpad-lite"
EPLITE_BIN="bin/safeRun.sh"
USER="etherpad-lite"
GROUP="etherpad-lite"
DESC="Etherpad Lite"
NAME="etherpad-lite"

set -e

. /lib/lsb/init-functions

start() {
  echo "Starting $DESC... "
  
        start-stop-daemon --start --chuid "$USER:$GROUP" --background --make-pidfile --pidfile /var/run/$NAME.pid --exec $EPLITE_DIR/$EPLITE_BIN -- $LOGFILE || true
  echo "done"
}

#We need this function to ensure the whole process tree will be killed
killtree() {
    local _pid=$1
    local _sig=${2-TERM}
    for _child in $(ps -o pid --no-headers --ppid ${_pid}); do
        killtree ${_child} ${_sig}
    done
    kill -${_sig} ${_pid}
}

stop() {
  echo "Stopping $DESC... "
   while test -d /proc/$(cat /var/run/$NAME.pid); do
    killtree $(cat /var/run/$NAME.pid) 15
    sleep 0.5
  done
  rm /var/run/$NAME.pid
  echo "done"
}

status() {
  status_of_proc -p /var/run/$NAME.pid "" "etherpad-lite" && exit 0 || exit $?
}

case "$1" in
  start)
          start
          ;;
  stop)
    stop
          ;;
  restart)
          stop
          start
          ;;
  status)
          status
          ;;
  *)
          echo "Usage: $NAME {start|stop|restart|status}" >&2
          exit 1
          ;;
esac

exit 0
# You should know what this is
chmod +x /etc/init.d/etherpad-lite

And then(?)

update-rc.d etherpad-lite defaults

Create the Apache proxying config at /etc/apache2/sites-available/etherpadlite.proxy

<VirtualHost *:80>

        ServerName pad1.pmtpa.wmflabs
        RewriteEngine on
        ProxyVia On
        ProxyRequests Off
        ProxyPass / http://127.0.0.1:9001/
        ProxyPassReverse / http://127.0.0.1:9001/
        ProxyPreserveHost On
        
        <Proxy *>
                Options FollowSymLinks MultiViews
                AllowOverride All
                Order allow,deny
                Allow from all
    </Proxy>

</VirtualHost>
#<VirtualHost *:443>
#
#        ServerName pad1.pmtpa.wmflabs
#        SSLEngine on
#        SSLCertificateFile /etc/ssl/certs/star.wikimedia.org.pem
#        SSLCertificateKeyFile /etc/ssl/private/star.wikimedia.org.key
#        RewriteEngine on
#        ProxyVia On
#        ProxyRequests Off
#        ProxyPass / http://127.0.0.1:9001/
#        ProxyPassReverse / http://127.0.0.1:9001/
#        ProxyPreserveHost On
#
#        <Proxy *>
#                Options FollowSymLinks MultiViews
#                AllowOverride All
#                Order allow,deny
#                Allow from all
#        </Proxy>
#
#</VirtualHost>

Make sure Proxy_http and Rewrite mods are enabled for apache.

Use MySQL

Because sqlite sucks for multi-user applications we need to use MySQL. Once Etherpad Lite supports a propery key-value database we should switch to that but until then...

Just create a database in MySQL with a user for etherpadlite, and then set the options in settings.json. For example:

   "dbType" : "mysql",
   "dbSettings" : {
                    "user"    : "etherpadlite",
                    "host"    : "localhost",
                    "password": "etherpadlite",
                    "database": "etherpadlite"
                  },