egroupware/swoolepush

EGroupware push server using Swoole

23.1.20241111 2024-11-11 08:56 UTC

Requires

• easyswoole/memcache-pool: ^1.0
• egroupware/exception: ^2.1.0
• egroupware/hstream: ^1.7.0
• egroupware/idna: ^1.2.0
• egroupware/listheaders: ^1.3.0
• egroupware/mail: ^2.7.0
• egroupware/mime: ^2.13.0
• egroupware/stream-filter: ^2.1.0
• egroupware/stream-wrapper: ^2.2.0
• egroupware/support: ^2.3.0
• egroupware/text-flowed: ^2.1.0
• egroupware/translation: ^2.3.0
• egroupware/util: ^2.7.0

Requires (Dev)

• eaglewu/swoole-ide-helper: dev-english

GPL-2.0-or-later

• Ralf Becker

README

Open tasks:

• check session matches HTTP host / instance AND session is not anonymous
• rotate token by async job and push new tokens to active sessions
• require Bearer token to authorize requests / send push messages
• check sessionid cookie when client opens a websocket connection

Installation instructions

Most easy installation is the one comming with the container based development system.

To install EGroupwares push server for a regular webserver running on the host follow these instructions:

cd /path/to/egroupware
git clone [e-mail]:EGroupware/swoolpush.git
cd swoolpush
docker run --rm -it -v $(pwd):/var/www -v /var/lib/php/sessions:/var/lib/php/sessions -p9501:9501 phpswoole/swoole

You need to adapt the session-directory, if you are not using Ubuntu.

Then visit setup and install swoolpush app (no run rights for users neccessary).

You need to proxy the /push URL into the container, eg. for Apache

<Location /egroupware/push>
    Order allow,deny
    Allow from all

    RewriteEngine On
    RewriteCond %{HTTP:Upgrade} =websocket [NC]
    RewriteRule /var/www/(.*)           ws://localhost:9501/$1 [P,L]
    RewriteCond %{HTTP:Upgrade} !=websocket [NC]
    RewriteRule /var/www/(.*)           http://localhost:9501/$1 [P,L]

    ProxyPreserveHost On
    ProxyPassReverse http://localhost:9501
</Location>

You need to change the above /var/www, in case you use a different document root.

eg. for Nginx

location  /egroupware/push {
                proxy_http_version 1.1;
                proxy_set_header Host $http_host;
                proxy_set_header Upgrade $http_upgrade;
                proxy_set_header Connection "Upgrade";
                proxy_pass http://localhost:9501;
        }

Send a test-message

You can get a token from the server output, when a client connects.

curl -i -H 'Content-Type: application/json' -X POST 'https://boulder.egroupware.org/egroupware/push?token=<token>' \
  -d '{"type":"message","data":{"message":"Hi ;)","type":"notice"}}'

Remember you need to restart the Docker container, when you make changes to the server!