Public | Automated Build

Last pushed: 2 years ago
Short Description
Short description is empty for this repo.
Full Description

Implements https://buddycloud.org/wiki/Buddycloud_HTTP_API

Build status

Build status of master branch

Build status of the develop branch

Install

Install documentation is at https://buddycloud.org/wiki/Install

Realtime connection

A websocket (using the xmpp-ftw interface can be found at $server/scripts/buddycloud.js. This exposes a global object called Buddycloud
which you can instantiate to give you a websocket connection.

Please see buddycloud.com for more information on using this connection.

Docker

There is a docker image available for the API server. Configuration is currently passed via environment variables:

Configuration Example Description Required or default
XMPP_DOMAIN buddycloud.org The XMPP domain for your server
XMPP_HOST 192.168.0.55 The hostname or IP of your XMPP server
CHANNEL_COMPONENT channels.buddycloud.org The channel server component address
ANONYMOUS_COMPONENT anon.buddycloud.org An 'anonymous' component which can be used for open nodes null
MEDIA_ENDPOINT http://192.168.0.56:9000 The endpoint for a media server null
PUSHER_COMPONENT pusher.buddycloud.org The location of a pusher component null
FRIENDFINDER_COMPONENT finder.buddycloud.org The location of a friend finder component null
SEARCH_COMPONENT search.buddycloud.org The location of a search component null
DISABLE_WEBSOCKET 0 Whether to disable the XMPP-FTW endpoint false
DEBUG 1 Whether to write additional debug to the logs false

Then simply launch the API server with the required environment variables as follows:

docker run -d -p 9123:9123 -e ..... buddycloud/api-server

Issues

Please log any issues at https://github.com/buddycloud/buddycloud-http-api/issues

Developers

For developing please see the config file named config.js.developer-example.

License and copyright

This code is Apache 2 licensed and copyright buddycloud.

Docker Pull Command
Owner
buddycloud
Source Repository

Comments (0)