A media server for buddycloud channels. It provides a simple REST-like HTTP interface where clients can do several operations like:
- upload: upload media to private/public channels, the permissions are based on channels pubsub subscriptions;
- download: download/visualize media from channels that you have enough permissions;
- delete: you can delete medias that you've uploaded or if you are a channel moderator/owner;
- update: update media metadata, with similar permissions as the delete operation.
To authenticate HTTP requests, the media server uses XEP-0070, this means that the client must have an XMPP client that "understands" such protocol in order to do media operations. There is only one exception: download media from public channels - any client has access.
The API is described in detail here.
The server is written on top of Java using RESTlet.
It uses Maven to build its packages. You can build the package manually or download it from here.
After unpacking, you can then start it by invoking
bash mediaserver
The server needs to be configured for the buddycloud/XMPP server it should communicate with. See the Configuration section.
You can configure the media server by copying configuration.properties.example to
configuration.properties in the server's root directory, and then editing as
required. This file has multiple properties definitions:
# HTTP
http.port=8080
https.port=8443
https.enabled=true
https.keystore.path=/$HOME/.jetty/jetty.jks
https.keystore.type=JSK
https.keystore.password=password
https.key.password=password
# XMPP
xmpp.component.host=localhost
xmpp.component.port=5275
xmpp.component.subdomain=mediaserver
xmpp.component.secretkey=secret
xmpp.connection.username=mediaserver-test
xmpp.connection.password=mediaserver-test
xmpp.connection.host=crater.buddycloud.org
xmpp.connection.port=5222
xmpp.connection.servicename=buddycloud.org
# buddycloud
bc.channels.server=channels.buddycloud.org
# JDBC
jdbc.db.url=jdbc:postgresql://localhost:5432/mediaserver?user=postgres&password=postgres
jdbc.driver.class=org.postgresql.Driver
# File System
media.storage.root=/tmp
media.sizelimit=1000240
The following configuration options are supported:
HTTP related configurations:
- https.enabled (Optional): if the HTTPS is enabled (default is false). If is set to true you must provide the others https properties.
- https.port: the port where the server will listen for HTTPS requests.
- https.keystore: the HTTPS keystore location.
- https.keystore.type: the keystore type.
- https.keystore.password: the keystore password.
- https.key.password: the HTTPS key password.
- http.port (Optional): the HTTP port where the server will listen for HTTP requests (default is 8080).
XMPP related:
- xmpp.component.host (Required): the XMPP server location where the media server's component will connect.
- xmpp.component.port (Required): the XMPP server components connection listening port.
- xmpp.component.subdomain (Required): the subdomain that will be used by the component.
- xmpp.component.secretkey (Required): the secretkey defined at the XMPP server for components connections.
In addition of the component, the media server also have a simple client that handles pubsub queries:
- xmpp.connection.username (Required): the username used by the cient's connection.
- xmpp.connection.password (Required): client's connection password.
- xmpp.connection.host (Required): XMPP server location.
- xmpp.connection.port (Required): XMPP server port for clients connections.
- xmpp.connection.servicename (Required): client's connection servicename.
buddycloud related:
- bc.channels.server (Required): list of channels' pubsub servers where the media server will look for possible permissions. Note that this configuration limits the domains served by the server.
Storage related:
- jdbc.db.url (Required): the server uses PostgresSQL to store media's metadata and uses JDBC to access it.
- jdbc.driver.class (Optional): if someday the media server allow a different database, this property will be used (default is org.postgresql.Driver).
- media.storage.root (Required): root path where the media server will store the media files.
- media.sizelimit (Optional): the tolerated file size in bytes (default is 1048576 - 1 MB) which beyond are directly stored on disk.