[{"_1":2,"_192":-5,"_193":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_167":168},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_85":86,"_107":108,"_158":-5,"_159":11,"_160":17,"_161":11,"_162":-5,"_163":11,"_164":-5,"_165":166},"canonicalUrl","https://hub.docker.com/r/buddycloud/media-server/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","buddycloud","reponame","media-server","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":-5,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":65,"_66":67,"_68":11,"_69":29,"_70":71,"_76":17,"_77":78,"_82":29,"_83":84},"categories",[],"content_types",[40],"image","date_registered","2014-10-21T10:38:31.112559Z","description","","is_private","last_updated","2015-10-19T21:11:13.850187Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.distribution.manifest.v1+prettyjws","name","pull_count",1240,"repository_type","star_count",3,"status",1,"status_description","active","source","collaborator_count",0,"full_description","buddycloud-media-server\n=======================\n\nA media server for [buddycloud][bc] channels. It provides a simple \nREST-like HTTP interface where clients can do several operations like:\n- **upload**: upload media to private/public channels, the permissions\nare based on channels [pubsub subscriptions][pubsub];\n- **download**: download/visualize media from channels that you have \nenough permissions;\n- **delete**: you can delete medias that you've uploaded or if you are\na channel moderator/owner;\n- **update**: update media metadata, with similar permissions as the\ndelete operation.\n \nTo authenticate HTTP requests, the media server uses [XEP-0070][xep],\nthis means that the client **must** have an XMPP client that \"understands\"\nsuch protocol in order to do media requests. There is only one exception: \ndownload media from public channels - any client has access.\n\n[bc]: http://buddycloud.com/\n[xep]: http://xmpp.org/extensions/xep-0070.html\n[pubsub]: https://buddycloud.org/wiki/XMPP_XEP#Follower_Management\n\n# Build status:\n\n * Released version: [![Build Status](https://travis-ci.org/buddycloud/buddycloud-media-server.svg?branch=master)](https://travis-ci.org/buddycloud/buddycloud-media-server) \n * Development version: [![Build Status](https://travis-ci.org/buddycloud/buddycloud-media-server.svg?branch=develop)](https://travis-ci.org/buddycloud/buddycloud-media-server) \n\n# Deployment\n\n[ ![Download](https://api.bintray.com/packages/buddycloud/builds/buddycloud-media-server/images/download.svg) ](https://bintray.com/buddycloud/builds/buddycloud-media-server/_latestVersion)\n\n__Note:__ Always ensure that you have a database/XMPP server set up and running first.\n\n## Running manually\n\n```\nmvn package\njava -jar target/buddycloud-media-server--jar-with-dependencies.jar\n```\n\n`mediaserver.properties` must be in the classpath.\n\n## Docker\n\n```\ndocker run -d buddycloud/media-server\n```\n\n__Note:__ Don't forget to expose the HTTP port (plus additional as required).\n\n### Configuration\n\nWhen running with docker there are two methods which you can use to configure the server. For more information see [configuration parameters](https://github.com/buddycloud/buddycloud-media-server#configuration).\n\n#### Mounted volume configuration\n\n'Mounted volume' configuration works the same as including a `mediaserver.properties` file. In this case you need to mount your configuration directory at `/config/media-server` on the docker image. The media server is set up to check this directory for config files.\n\n#### Database configuration\n\nStarting a docker container with the environment variable of `DATABASE` set to a postgresql connection string will load configuration from the database, e.g.:\n\n```\ndocker run -d DATABASE=\"jdbc:postgresql://localhost:5432/media-server?user=media&password=tellnoone\" buddycloud/media-server\n```\n\n### Datastorage\n\nYou'll also need a mount a volume to store your media files. Ensure the mounted location matches that in your configuration.\n\n# Usage\n\n## Via the Buddycloud API\n\nThe API endpoints are described in detail [here](https://buddycloud.org/wiki/Buddycloud_HTTP_API#.2F.3Cchannel.3E.2Fmedia.2F.3Citem.3E).\n\n## Using the Media Server directly\n\n### Discovering the HTTP endpoint\n\nIn order to figure out which endpoint to send HTTP calls to, we use [XMPP Service Discovery] (http://xmpp.org/extensions/xep-0030.html) against the domain running the media server. In the folowing example, we use buddycloud.org as the target domain. We first list all services provided by buddycloud.org and then we pick the one with name \"Media Server\".\n\ndisco#items against buddycloud.org:\n\n```xml\n\n \n\n\n\n \n \n \n \n \n \n \n \n\n```\n\ndisco#info against mediaserver.buddycloud.org:\n\n```xml\n\n \n\n\n\n \n \n \n \n \n \n \n http://buddycloud.org/v1/api\n https://demo.buddycloud.org/api/media_proxy\n \n \n\n```\n\nThe response of the disco#info query against the media server contains a dataform that holds information on how to communicate with the server. Then field named 'endpoint' will then give us the endpoint for HTTP calls. In the previous example, we should use **https://demo.buddycloud.org/api/media_proxy**.\n\nThe endpoint can be advertised by adding the following key (example data) to your `mediaserver.properties`:\n\n```\nhttp.endpoint=https://api.buddycloud.org/media_proxy\n```\n\n### If media belongs to a public channel\n\nYou don't need an ```Authorization``` header. Notice that if you're building a web frontend, embedding public media from the media-server means just creating an `````` tag. \n\n**GET**\n\n```bash\ncurl https://demo.buddycloud.org/api/media_proxy/media-channel@example.com/mediaId\n```\n\n### If media belongs to a private channel\n\nYou need to verify your request via XMPP and generate an ```Authorization``` header as following: \n\n#### Generating a transaction id\n\nAs per [XEP 0070](http://www.xmpp.org/extensions/xep-0070.html), every transaction with the media server that requires authentication must have an unique identifier within the context of the client's interaction with the server. This identifier will be sent over to the media server via HTTP and then sent back to the client via XMPP in order to confirm the client's identity.\n\nFor this example, we will use **a7374jnjlalasdf82** as a transaction id.\n\n#### Listening for confirmation\n\nBefore sending the actual HTTP request, the client has to setup an XMPP listener for the confirmation request. The message sent by the media server complies with [XEP 0070](http://www.xmpp.org/extensions/xep-0070.html) and will be in the lines of:\n\n```xml\n\n a8da1a353de44aea831e6b9da588b72e\n Confirmation message for transaction a7374jnjlalasdf82\n \n\n```\n\nThe client should simply confirm the request by replying to the message:\n\n```xml\n\n a8da1a353de44aea831e6b9da588b72e\n Confirmation message for transaction a7374jnjlalasdf82\n \n\n```\n\n###### Sending the HTTP request\n\nIn order to build the URL for HTTP requests, we must consider the media endpoint, the channel the media was (or will be) posted and the media id (in case of GET or DELETE).\n\nThe requests that require authentication must go with an authorization header, which should be the concatenation of the client's full jid, plus a ':', plus the transaction id, converted to base64 (URL safe). I.e., let's assume the client's full jid is media-user@example.com/media-resource and the transaction id is, again, a7374jnjlalasdf82:\n\nAuthorization: Basic urlbase64('media-user@example.com/media-resource:a7374jnjlalasdf82')\n\nAuthorization: Basic bWVkaWEtdXNlckBleGFtcGxlLmNvbS9tZWRpYS1yZXNvdXJjZTphNzM3NGpuamxhbGFzZGY4Mg==\n\nNote: the urlbase64 method should comply with http://tools.ietf.org/html/rfc4648#page-7. In python, for instance, that's base64.urlsafe_b64encode(s).\n\nThe following curl examples perform media-related operations within the media-channel@example.com channel.\n\n**POST**\n\n```bash\ncurl -X POST -H \"Authorization: Basic bWVkaWEtdXNlckBleGFtcGxlLmNvbS9tZWRpYS1yZXNvdXJjZTphNzM3NGpuamxhbGFzZGY4Mg==\" -F filename=localfile.jpg -F data=@localfile.jpg -F title=\"New media\" -F description=\"New media description\" https://demo.buddycloud.org/api/media_proxy/media-channel@example.com\n```\n\n**GET**\n\n```bash\ncurl -H \"Authorization: Basic bWVkaWEtdXNlckBleGFtcGxlLmNvbS9tZWRpYS1yZXNvdXJjZTphNzM3NGpuamxhbGFzZGY4Mg==\" https://demo.buddycloud.org/api/media_proxy/media-channel@example.com/mediaId\n```\n\n**DELETE**\n\n```bash\ncurl -X DELETE -H \"Authorization: Basic bWVkaWEtdXNlckBleGFtcGxlLmNvbS9tZWRpYS1yZXNvdXJjZTphNzM3NGpuamxhbGFzZGY4Mg==\" https://demo.buddycloud.org/api/media_proxy/media-channel@example.com/mediaId\n```\n\n# Setup\n\nThe server is written on top of Java using [RESTlet](http://www.restlet.org/).\n\nIt uses [Maven](http://maven.apache.org/) to build its packages. You can build\nthe package manually or download it from [here](http://downloads.buddycloud.com/).\n\nSetup database tables using the scripts at https://raw.githubusercontent.com/buddycloud/buddycloud-media-server/master/postgres\n\n## Configuration\n\n### File configuration\n\nYou can configure the media server by copying `mediaserver.properties.example` to \n`mediaserver.properties` in the server's root directory, and then editing as \nrequired.\n\nThe server is able to pick up a `mediaserver.properties` file up from anywhere in the system path.\n\n### Database configuration\n\nSet an environment variable as per the following example:\n\n```\nDATABASE=\"jdbc:postgresql://localhost:5432/buddycloud-server?user=buddycloud&password=tellnoone\"\n```\n\nThe server will then use the database values to configure itself, the configuration.properties file will be ignored.\n\n### Configuration file\n\nThis file has multiple properties definitions:\n\n```\n # HTTP \n http.port=8080\n http.tests.port=9090\n http.endpoint=https://api.buddycloud.org/media_proxy\n https.port=8443\n https.enabled=true\n https.keystore.path=/$HOME/.jetty/jetty.jks\n https.keystore.type=JSK\n https.keystore.password=password\n https.key.password=password\n \n # XMPP\n xmpp.component.host=localhost\n xmpp.component.port=5275\n xmpp.component.subdomain=mediaserver\n xmpp.component.servername=example.com\n xmpp.component.secretkey=secret\n \n xmpp.connection.username=mediaserver-test\n xmpp.connection.password=mediaserver-test\n xmpp.connection.host=localhost\n xmpp.connection.port=5222\n xmpp.connection.servicename=example.com \n \n # Whether the client will use SASL authentication when logging into the server (true|false).\n xmpp.connection.saslenabled=true\n \n # TLS security mode used when making the connection (disabled|enabled|required).\n xmpp.connection.securitymode=enabled\n \n # How much time it will wait for a response to an XMPP request (in milliseconds)\n xmpp.reply.timeout=30000\n \n # JDBC\n jdbc.db.url=jdbc:postgresql://localhost:5432/mediaserver?user=postgres&password=postgres\n jdbc.driver.class=org.postgresql.Driver\n \n # Max threshold beyond which files are written directly to disk, in bytes\n # Only used while uploading multipart form data files\n media.todisk.threshold=1048576\n \n # File System\n media.storage.root=/tmp\n media.sizelimit=1000240\n \n```\n\nThe following configuration options are supported:\n\nHTTP related configurations:\n\n- **http.endpoint** (Optional): if provided the HTTP endpoint of the media server will be advertised via DISCO#info using XEP-0128 Service Discovery Extensions.\n- **https.enabled** (Optional): if the HTTPS is enabled (default is **false**). If is set to **true**\nyou **must** provide the others *https* properties.\n- **https.port**: the port where the server will listen for HTTPS requests.\n- **https.keystore**: the HTTPS keystore location.\n- **https.keystore.type**: the keystore type.\n- **https.keystore.password**: the keystore password.\n- **https.key.password**: the HTTPS key password.\n- **http.port** (Optional): the HTTP port where the server will listen for HTTP requests (default is *8080*).\n- **http.tests.port** (Optional): the HTTP port where the server will listen for HTTP requests while running tests (default is *9090*).\n\nXMPP related:\n\n- **xmpp.component.host** (Required): the XMPP server location where the media server's component will connect. \n- **xmpp.component.port** (Required): the XMPP server components connection listening port.\n- **xmpp.component.subdomain** (Required): the *subdomain* that will be used by the component.\n- **xmpp.component.servername** (Required): the *servername* (server domain).\n- **xmpp.component.secretkey** (Required): the *secretkey* defined at the XMPP server for components connections.\n\t\nIn addition of the component, the media server also have a simple client that handles pubsub queries: \n\n- **xmpp.connection.username** (Required): the *username* used by the cient's connection.\n- **xmpp.connection.password** (Required): client's connection *password*.\n- **xmpp.connection.host** (Required): XMPP server location.\n- **xmpp.connection.port** (Required): XMPP server port for clients connections.\n- **xmpp.connection.servicename** (Required): client's connection *servicename*.\n\n- **xmpp.reply.timeout** (Optional): timeout in milliseconds to wait a response to an XMPP request (default is 30000)\n\nStorage related:\n\n- **jdbc.db.url** (Required): the server uses [PostgresSQL](http://www.postgresql.org) to store\nmedia's metadata and uses [JDBC](http://www.oracle.com/technetwork/java/overview-141217.html) to access it.\n- **jdbc.driver.class** (Optional): if someday the media server allow a different database, this\nproperty will be used (default is *org.postgresql.Driver*).\n- **media.storage.root** (Required): root path where the media server will store the media files.\n- **media.sizelimit** (Optional): the tolerated file content size which the media server will store (default is *104857600* - 100 MB).\n- **media.todisk.threshold** (Optional): the tolerated file size in bytes (default is *1048576* - 1 MB) which beyond are directly stored on disk.\n\n### Logging\n\nThe buddycloud media server relies on [logback](http://logback.qos.ch/manual/configuration.html) for writing logs out. In order to configure itself, Logback will: \n\n1. try to find a file called logback.groovy in the classpath.\n\n1. If no such file is found, it tries to find a file called logback-test.xml in the classpath.\n\n1. If no such file is found, it checks for the file logback.xml in the classpath..\n\n1. If neither file is found, logback configures itself automatically using the BasicConfigurator which will cause logging output to be directed to the console.\n \nA logback.xml with two appenders (```STDOUT``` writing in the console and ```FILE``` writing on a file) and with the root logger using the ```FILE``` appender looks like this:\n\n```xml\n\n \n /var/log/buddycloud-media-server/mediaserver.log\n \n %-5relative %-5level %logger{35} - %msg%n\n \n \n\n \n \n %-5relative %-5level %logger{35} - %msg%n\n \n \n\n \n \n \n\n```\n","has_starred","hub_user","immutable_tags_settings",{"_72":11,"_73":74},"enabled","rules",[75],".*","is_automated","permissions",{"_79":17,"_80":11,"_81":11},"read","write","admin","user","storage_size",1122112960,"orgData",{"_87":88,"_89":90,"_91":92,"_93":29,"_94":44,"_95":44,"_96":97,"_98":99,"_100":101,"_102":103,"_104":44,"_105":44,"_106":17},"id","1516636e74c111e4bea40242ac11001b","uuid","1516636e-74c1-11e4-bea4-0242ac11001b","type","organization","orgname","full_name","location","company","Buddycloud","profile_url","http://www.buddycloud.com/","date_joined","2013-11-09T13:47:35Z","gravatar_url","https://www.gravatar.com/avatar/52d5c001e2778b9af33ae1af80e0e7c3?s=80&r=g&d=mm","gravatar_email","badge","is_active","recentTags",[109,147],{"_110":40,"_111":112,"_113":114,"_115":116,"_87":117,"_118":119,"_46":134,"_135":136,"_137":138,"_139":52,"_53":140,"_141":142,"_143":125,"_144":134,"_145":62,"_146":17},"content_type","creator",5031,"digest","sha256:9e1054fa145809148c56d4fc457cef2e15c5d688726ea35c7d2d0aa95d74837b","full_size",555633103,53073,"images",[120],{"_121":122,"_113":114,"_123":44,"_124":125,"_126":127,"_128":44,"_129":44,"_130":-5,"_131":132,"_59":62,"_133":-5},"architecture","amd64","features","last_pulled","2026-09-23T10:39:07.460996368Z","last_pushed","2015-10-19T21:11:13Z","os","os_features","os_version","size",555633455,"variant","2015-10-19T21:11:14Z","last_updater",22552,"last_updater_username","lloydwatkin","media_type","latest","repository",70092,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_110":40,"_111":112,"_113":148,"_115":149,"_87":150,"_118":151,"_46":156,"_135":136,"_137":138,"_139":52,"_53":157,"_141":142,"_143":153,"_144":156,"_145":62,"_146":17},"sha256:36c59b634d913a4f405742e9faeda9543157e0a0a917267d6ff452929d07e441",566377807,53063,[152],{"_121":122,"_113":148,"_123":44,"_124":153,"_126":154,"_128":44,"_129":44,"_130":-5,"_131":155,"_59":62,"_133":-5},"2026-09-13T04:07:00.931843119Z","2015-10-19T21:00:52Z",566378159,"2015-10-19T21:00:53Z","stable","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":169,"_176":177,"_165":190,"_191":11},{"_36":170,"_38":171,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":172,"_53":31,"_28":29,"_54":55,"_56":-5,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":65,"_66":67,"_68":11,"_69":29,"_70":173,"_76":17,"_77":175,"_82":29,"_83":84},[],[40],[52],{"_72":11,"_73":174},[75],{"_79":17,"_80":11,"_81":11},"tags",{"_178":179,"_180":-5,"_181":-5,"_182":183},"count",2,"next","previous","results",[184,187],{"_110":40,"_111":112,"_113":114,"_115":116,"_87":117,"_118":185,"_46":134,"_135":136,"_137":138,"_139":52,"_53":140,"_141":142,"_143":125,"_144":134,"_145":62,"_146":17},[186],{"_121":122,"_113":114,"_123":44,"_124":125,"_126":127,"_128":44,"_129":44,"_130":-5,"_131":132,"_59":62,"_133":-5},{"_110":40,"_111":112,"_113":148,"_115":149,"_87":150,"_118":188,"_46":156,"_135":136,"_137":138,"_139":52,"_53":157,"_141":142,"_143":153,"_144":156,"_145":62,"_146":17},[189],{"_121":122,"_113":148,"_123":44,"_124":153,"_126":154,"_128":44,"_129":44,"_130":-5,"_131":155,"_59":62,"_133":-5},[],"canDeleteTags","actionData","errors"]

buddycloud/media-server

Tags for buddycloud/media-server