Chat package

Now noosfero will generate a debian package to install the chat. The generated package is named 'noosfero-chat'. Signed-off-by: Joenio Costa <joenio@colivre.coop.br>

Chat package
Now noosfero will generate a debian package to install the chat. The generated package is named 'noosfero-chat'. Signed-off-by: Joenio Costa <joenio@colivre.coop.br>
Rodrigo Souto · Joenio Costa
1 parent 0096a365
Showing 16 changed files with 180 additions and 14 deletions Show diff stats
INSTALL.chat.md
debian/apache2/conf.d/noosfero-chat
debian/changelog
debian/control
debian/default/noosfero-chat
debian/noosfero-chat.install
debian/noosfero-chat.postinst
debian/noosfero-runner
debian/noosfero.install
debian/update-noosfero-odbc
etc/pam.d/noosfero-chat
etc/security/limits.d/noosfero-chat.conf
script/apacheconf
script/noosfero-test-chat-session
script/odbcconf
util/chat/apache/xmpp.conf
-XMPP/Chat Setup
-===============
+Automatic XMPP/Chat Setup
+=========================
+
+Since Noosfero 1.2, the XMPP/Chat can be installed via `noosfero-chat` Debian
+package. So you don't need to follow the manual instructions here if you
+already have it installed on your system.
+
+But if you are going to install the `noosfero-chat` package on a system that
+already has `noosfero` older 1.2 installed then you need to check if apache's
+configuration file `/etc/apache2/sites-available/noosfero` has this line below:
+
+     Include /usr/share/noosfero/util/chat/apache/xmpp.conf
+
+Manual XMPP/Chat Setup
+======================
  
 The samples of config file to configure a XMPP/BOSH server with ejabberd,
 postgresql and apache2 can be found at util/chat directory.
@@ -8,7 +21,7 @@ This setup supposes that you are using Noosfero installed via Debian package
 in a production environment.
  
 Steps
-=====
+-----
  
 This is a step-by-step guide to get a XMPP service working, in a Debian system.
  
@@ -144,15 +157,8 @@ You should see a page with a message like that:
  
 ## 9. Test chat session
  
-Open Noosfero console and execute:
-
->> environment = Environment.default
->> user = Person['guest']
->> password = user.user.crypted_password
->> login = user.jid
->> RubyBOSH.initialize_session(login, password, "http://#{environment.default_hostname}/http-bind", :wait => 30, :hold => 1, :window => 5
-
-If you have luck, should see something like that:
+Run `./script/noosfero-test-chat-session`. If you have luck, should see
+something like that:
  
 Ruby-BOSH - SEND
 <body window="5" rid="60265" xmlns="http://jabber.org/protocol/httpbind" xmlns:xmpp="urn:xmpp:xbosh" to="vagrant-debian-squeeze.vagrantup.com" wait="30" xmpp:version="1.0" hold="1"/>
@@ -0,0 +1,9 @@
+<IfModule mpm_worker_module>
+   StartServers          8
+   MinSpareThreads       25
+   MaxSpareThreads       75
+   ThreadLimit           128
+   ThreadsPerChild       128
+   MaxClients            2048
+   MaxRequestsPerChild   0
+</IfModule>
-noosfero (1.2~0) UNRELEASED; urgency=medium
+noosfero (1.2~1) UNRELEASED; urgency=medium
  
+  [ Antonio Terceiro ]
   * Temporary version in heavy development
  
- -- Antonio Terceiro <terceiro@debian.org>  Fri, 08 May 2015 16:08:18 -0300
+  [ Joenio Costa ]
+  * Build noosfero-chat package
+
+ -- Joenio Costa <joenio@colivre.coop.br>  Mon, 18 May 2015 14:32:21 -0300
  
 noosfero (1.1) wheezy; urgency=low
  
@@ -85,3 +85,14 @@ Description: free web-based platform for social networks (apache frontend)
  .
  This package contains the configuration files needed to run Noosfero with the
  Apache HTTPD server as frontend.
+
+Package: noosfero-chat
+Architecture: all
+Depends: noosfero (>= 1.2), ejabberd, odbc-postgresql, pidgin-data
+Description: free web-based platform for social networks (ejabberd based chat)
+ Noosfero is a web platform for social and solidarity economy networks with
+ blog, e-Porfolios, CMS, RSS, thematic discussion, events agenda and collective
+ inteligence for solidarity economy in the same system.
+ .
+ This package contains the configuration files needed to run Noosfero with the
+ Ejabberd XMPP chat server.
@@ -0,0 +1,2 @@
+POLL=true
+SMP=auto
@@ -0,0 +1,6 @@
+debian/default/noosfero-chat                etc/default
+util/chat/ejabberd.cfg                      etc/ejabberd
+debian/update-noosfero-odbc                 usr/sbin
+etc/security/limits.d/noosfero-chat.conf    etc/security/limits.d
+etc/pam.d/noosfero-chat                     etc/pam.d
+debian/apache2/conf.d/noosfero-chat         etc/apache2/conf.d
@@ -0,0 +1,50 @@
+#!/bin/bash
+
+set -e
+
+. /usr/share/debconf/confmodule
+
+echo -n "Fetching noosfero domain ..."
+domain=$(noosfero-runner 'puts Environment.default.default_hostname(true)')
+echo " [domain = $domain]"
+
+ejabberd_config='/etc/ejabberd/ejabberd.cfg'
+if test -f $ejabberd_config; then
+  sed -i "s/acl, *\([^,]*\), *{user, *\([^,]*\), *[^}]*/acl, \1, {user, \2, \"$domain\"/" /etc/ejabberd/ejabberd.cfg
+  sed -i "s/hosts, *\[[^]]*/hosts, [\"$domain\"/" /etc/ejabberd/ejabberd.cfg
+fi
+
+echo -n 'Fetching noosfero database name ...'
+noosfero_database=$(noosfero-runner 'puts Environment.connection_config[:database]')
+echo " [database = $noosfero_database]"
+
+echo 'Creating ejabberd schema ...'
+. /etc/default/noosfero
+noosfero_user="$NOOSFERO_USER"
+su - postgres -c "psql -c 'GRANT CREATE ON DATABASE $noosfero_database TO $noosfero_user;' > /dev/null"
+su - $noosfero_user -c 'rails dbconsole production < /usr/share/noosfero/util/chat/postgresql/ejabberd.sql > /dev/null'
+
+if which update-noosfero-odbc > /dev/null ; then
+  update-noosfero-odbc
+fi
+
+ejabberd_default='/etc/default/ejabberd'
+noosfero_chat_default='/etc/default/noosfero-chat'
+if test -f $ejabberd_default; then
+  if ! cat $ejabberd_default | grep "^\. $noosfero_chat_default" > /dev/null ; then
+    echo 'Extending ejabberd defaults with noosfero-chat defaults ...'
+    echo ". $noosfero_chat_default" >> $ejabberd_default
+  fi
+fi
+
+a2enmod proxy_http
+
+invoke-rc.d ejabberd restart
+invoke-rc.d noosfero restart
+invoke-rc.d apache2  restart
+
+# stop debconf to avoid the problem with infinite hanging, cfe
+# http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=295477
+db_stop
+
+#DEBHELPER#
@@ -0,0 +1,8 @@
+#!/bin/sh
+
+set -e
+
+environment="$2"
+test -z "$environment" && environment=production
+
+su - noosfero -c "rails runner -e $environment '$1'"
@@ -17,6 +17,7 @@ debian/dbupgrade                  usr/lib/noosfero
 debian/default/noosfero           etc/default
 debian/noosfero-check-dbconfig    usr/sbin
 debian/noosfero-console           usr/sbin
+debian/noosfero-runner            usr/sbin
 debian/noosfero.yml               etc/noosfero
 debian/thin.yml                   etc/noosfero
 doc                               usr/share/noosfero
@@ -0,0 +1,14 @@
+#!/bin/sh
+
+set -e
+
+# automatically update configuration, but if package noosfero is also installed
+if test -x /usr/share/noosfero/script/odbcconf; then
+  config_file="/etc/odbc.ini"
+  if test -e "$config_file"; then
+    echo "Overwriting $config_file ..."
+  fi
+  /usr/share/noosfero/script/odbcconf > "$config_file"
+
+  echo 'Noosfero ODBC configuration updated.'
+fi
@@ -0,0 +1 @@
+session required pam_limits.so
@@ -0,0 +1,2 @@
+ejabberd       hard    nofile  65536
+ejabberd       soft    nofile  65536
@@ -32,6 +32,7 @@ when &#39;virtualhosts&#39;
       puts "  #{server_directive} #{domain.name}"
       server_directive = 'ServerAlias'
     end
+    puts "  Include /usr/share/noosfero/util/chat/apache/xmpp.conf"
     puts "  Include /etc/noosfero/apache/virtualhost.conf"
     puts "</VirtualHost>"
   end
@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/environment'
+
+environment = Environment.default
+person = Person.first
+password = person.user.crypted_password
+login = person.jid
+
+begin
+  RubyBOSH.initialize_session(
+    login,
+    password,
+    "http://#{environment.default_hostname}/http-bind",
+    :wait => 30,
+    :hold => 1,
+    :window => 5
+  )
+rescue Exception => e
+  puts ""
+  puts "[ERROR] XMPP/Chat setup isn't working"
+  puts "-------------------------------------"
+  puts e.to_s
+  exit 1
+else
+  puts ""
+  puts "[OK] XMPP/Chat setup is working"
+  exit 0
+end
@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+config = YAML.load_file(File.dirname(__FILE__) + '/../config/database.yml')['production']
+
+
+puts "[PostgreSQLEjabberdNoosfero]"
+puts "Description      = PostgreSQL Noosfero ejabberd database"
+puts "Driver           = PostgreSQL Unicode"
+puts "Trace            = No"
+puts "TraceFile        = /tmp/psqlodbc.log"
+puts "Database         = #{config['database']}"
+puts "Servername       = #{config['host'] || 'localhost'}"
+puts "UserName         = #{config['username']}"
+puts "Password         = #{config['password']}"
+puts "Port             = #{config['port'] || '5432'}"
+puts "ReadOnly         = No"
+puts "RowVersioning    = No"
+puts "ShowSystemTables = No"
+puts "ShowOidColumn    = No"
+puts "FakeOidIndex     = No"
+puts "ConnSettings     = SET search_path TO ejabberd"
 # If your XMPP XMPP/BOSH isn't in localhost, change the config below to correct
 # point to address
  
+  RewriteEngine On
   RewriteRule /http-bind http://localhost:5280/http-bind [P,QSA,L]
   <Proxy http://localhost:5280/http-bind>
     Order Allow,Deny
1		-XMPP/Chat Setup
2		-===============
	1	+Automatic XMPP/Chat Setup
	2	+=========================
	3	+
	4	+Since Noosfero 1.2, the XMPP/Chat can be installed via `noosfero-chat` Debian
	5	+package. So you don't need to follow the manual instructions here if you
	6	+already have it installed on your system.
	7	+
	8	+But if you are going to install the `noosfero-chat` package on a system that
	9	+already has `noosfero` older 1.2 installed then you need to check if apache's
	10	+configuration file `/etc/apache2/sites-available/noosfero` has this line below:
	11	+
	12	+ Include /usr/share/noosfero/util/chat/apache/xmpp.conf
	13	+
	14	+Manual XMPP/Chat Setup
	15	+======================
3	16
4	17	The samples of config file to configure a XMPP/BOSH server with ejabberd,
5	18	postgresql and apache2 can be found at util/chat directory.
...	...	@@ -8,7 +21,7 @@ This setup supposes that you are using Noosfero installed via Debian package
8	21	in a production environment.
9	22
10	23	Steps
11		-=====
	24	+-----
12	25
13	26	This is a step-by-step guide to get a XMPP service working, in a Debian system.
14	27
...	...	@@ -144,15 +157,8 @@ You should see a page with a message like that:
144	157
145	158	## 9. Test chat session
146	159
147		-Open Noosfero console and execute:
148		-
149		->> environment = Environment.default
150		->> user = Person['guest']
151		->> password = user.user.crypted_password
152		->> login = user.jid
153		->> RubyBOSH.initialize_session(login, password, "http://#{environment.default_hostname}/http-bind", :wait => 30, :hold => 1, :window => 5
154		-
155		-If you have luck, should see something like that:
	160	+Run `./script/noosfero-test-chat-session`. If you have luck, should see
	161	+something like that:
156	162
157	163	Ruby-BOSH - SEND
158	164	<body window="5" rid="60265" xmlns="http://jabber.org/protocol/httpbind" xmlns:xmpp="urn:xmpp:xbosh" to="vagrant-debian-squeeze.vagrantup.com" wait="30" xmpp:version="1.0" hold="1"/>
...	...
...	...	@@ -0,0 +1,9 @@
	1	+<IfModule mpm_worker_module>
	2	+ StartServers 8
	3	+ MinSpareThreads 25
	4	+ MaxSpareThreads 75
	5	+ ThreadLimit 128
	6	+ ThreadsPerChild 128
	7	+ MaxClients 2048
	8	+ MaxRequestsPerChild 0
	9	+</IfModule>
...	...
1		-noosfero (1.2~0) UNRELEASED; urgency=medium
	1	+noosfero (1.2~1) UNRELEASED; urgency=medium
2	2
	3	+ [ Antonio Terceiro ]
3	4	* Temporary version in heavy development
4	5
5		- -- Antonio Terceiro <terceiro@debian.org> Fri, 08 May 2015 16:08:18 -0300
	6	+ [ Joenio Costa ]
	7	+ * Build noosfero-chat package
	8	+
	9	+ -- Joenio Costa <joenio@colivre.coop.br> Mon, 18 May 2015 14:32:21 -0300
6	10
7	11	noosfero (1.1) wheezy; urgency=low
8	12
...	...
...	...	@@ -85,3 +85,14 @@ Description: free web-based platform for social networks (apache frontend)
85	85	.
86	86	This package contains the configuration files needed to run Noosfero with the
87	87	Apache HTTPD server as frontend.
	88	+
	89	+Package: noosfero-chat
	90	+Architecture: all
	91	+Depends: noosfero (>= 1.2), ejabberd, odbc-postgresql, pidgin-data
	92	+Description: free web-based platform for social networks (ejabberd based chat)
	93	+ Noosfero is a web platform for social and solidarity economy networks with
	94	+ blog, e-Porfolios, CMS, RSS, thematic discussion, events agenda and collective
	95	+ inteligence for solidarity economy in the same system.
	96	+ .
	97	+ This package contains the configuration files needed to run Noosfero with the
	98	+ Ejabberd XMPP chat server.
...	...
...	...	@@ -0,0 +1,6 @@
	1	+debian/default/noosfero-chat etc/default
	2	+util/chat/ejabberd.cfg etc/ejabberd
	3	+debian/update-noosfero-odbc usr/sbin
	4	+etc/security/limits.d/noosfero-chat.conf etc/security/limits.d
	5	+etc/pam.d/noosfero-chat etc/pam.d
	6	+debian/apache2/conf.d/noosfero-chat etc/apache2/conf.d
...	...
...	...	@@ -0,0 +1,50 @@
	1	+#!/bin/bash
	2	+
	3	+set -e
	4	+
	5	+. /usr/share/debconf/confmodule
	6	+
	7	+echo -n "Fetching noosfero domain ..."
	8	+domain=$(noosfero-runner 'puts Environment.default.default_hostname(true)')
	9	+echo " [domain = $domain]"
	10	+
	11	+ejabberd_config='/etc/ejabberd/ejabberd.cfg'
	12	+if test -f $ejabberd_config; then
	13	+ sed -i "s/acl, \([^,]\), {user, \([^,]\), [^}]*/acl, \1, {user, \2, \"$domain\"/" /etc/ejabberd/ejabberd.cfg
	14	+ sed -i "s/hosts, \[[^]]/hosts, [\"$domain\"/" /etc/ejabberd/ejabberd.cfg
	15	+fi
	16	+
	17	+echo -n 'Fetching noosfero database name ...'
	18	+noosfero_database=$(noosfero-runner 'puts Environment.connection_config[:database]')
	19	+echo " [database = $noosfero_database]"
	20	+
	21	+echo 'Creating ejabberd schema ...'
	22	+. /etc/default/noosfero
	23	+noosfero_user="$NOOSFERO_USER"
	24	+su - postgres -c "psql -c 'GRANT CREATE ON DATABASE $noosfero_database TO $noosfero_user;' > /dev/null"
	25	+su - $noosfero_user -c 'rails dbconsole production < /usr/share/noosfero/util/chat/postgresql/ejabberd.sql > /dev/null'
	26	+
	27	+if which update-noosfero-odbc > /dev/null ; then
	28	+ update-noosfero-odbc
	29	+fi
	30	+
	31	+ejabberd_default='/etc/default/ejabberd'
	32	+noosfero_chat_default='/etc/default/noosfero-chat'
	33	+if test -f $ejabberd_default; then
	34	+ if ! cat $ejabberd_default \| grep "^\. $noosfero_chat_default" > /dev/null ; then
	35	+ echo 'Extending ejabberd defaults with noosfero-chat defaults ...'
	36	+ echo ". $noosfero_chat_default" >> $ejabberd_default
	37	+ fi
	38	+fi
	39	+
	40	+a2enmod proxy_http
	41	+
	42	+invoke-rc.d ejabberd restart
	43	+invoke-rc.d noosfero restart
	44	+invoke-rc.d apache2 restart
	45	+
	46	+# stop debconf to avoid the problem with infinite hanging, cfe
	47	+# http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=295477
	48	+db_stop
	49	+
	50	+#DEBHELPER#
...	...
...	...	@@ -0,0 +1,8 @@
	1	+#!/bin/sh
	2	+
	3	+set -e
	4	+
	5	+environment="$2"
	6	+test -z "$environment" && environment=production
	7	+
	8	+su - noosfero -c "rails runner -e $environment '$1'"
...	...
...	...	@@ -17,6 +17,7 @@ debian/dbupgrade usr/lib/noosfero
17	17	debian/default/noosfero etc/default
18	18	debian/noosfero-check-dbconfig usr/sbin
19	19	debian/noosfero-console usr/sbin
	20	+debian/noosfero-runner usr/sbin
20	21	debian/noosfero.yml etc/noosfero
21	22	debian/thin.yml etc/noosfero
22	23	doc usr/share/noosfero
...	...
...	...	@@ -0,0 +1,14 @@
	1	+#!/bin/sh
	2	+
	3	+set -e
	4	+
	5	+# automatically update configuration, but if package noosfero is also installed
	6	+if test -x /usr/share/noosfero/script/odbcconf; then
	7	+ config_file="/etc/odbc.ini"
	8	+ if test -e "$config_file"; then
	9	+ echo "Overwriting $config_file ..."
	10	+ fi
	11	+ /usr/share/noosfero/script/odbcconf > "$config_file"
	12	+
	13	+ echo 'Noosfero ODBC configuration updated.'
	14	+fi
...	...
...	...	@@ -0,0 +1,2 @@
	1	+ejabberd hard nofile 65536
	2	+ejabberd soft nofile 65536
...	...