{"id":18345419,"url":"https://github.com/jsxc/jsxc.roundcube","last_synced_at":"2025-04-06T08:31:43.835Z","repository":{"id":22883234,"uuid":"26231347","full_name":"jsxc/jsxc.roundcube","owner":"jsxc","description":"JavaScript XMPP Client for roundcube","archived":false,"fork":false,"pushed_at":"2018-08-06T08:35:22.000Z","size":7603,"stargazers_count":9,"open_issues_count":3,"forks_count":6,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-21T20:51:13.187Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://www.jsxc.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jsxc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-11-05T17:36:19.000Z","updated_at":"2020-09-30T05:37:28.000Z","dependencies_parsed_at":"2022-08-21T04:40:09.450Z","dependency_job_id":null,"html_url":"https://github.com/jsxc/jsxc.roundcube","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsxc%2Fjsxc.roundcube","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsxc%2Fjsxc.roundcube/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsxc%2Fjsxc.roundcube/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsxc%2Fjsxc.roundcube/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jsxc","download_url":"https://codeload.github.com/jsxc/jsxc.roundcube/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247457219,"owners_count":20941900,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T21:08:11.189Z","updated_at":"2025-04-06T08:31:41.783Z","avatar_url":"https://github.com/jsxc.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"This is a plugin for RoundCube that enables real-time web chat based on [JSXC](https://www.jsxc.org).\r\n\r\nJSXC is a JavaScript XMPP client, therefore it requires XMPP server. Before you begin, please check for JSXC [prerequisites](https://www.jsxc.org/installation.html).\r\n\r\n## Installation\r\n\r\nTo install the plugin, follow the [standard procedure for RoundCube plugin installation](https://plugins.roundcube.net).\r\n\r\nHere is the snippet for `composer.json`:\r\n```\r\n\"require\" : {\r\n    ...,\r\n    \"jsxc/jsxc\": \"\u003e=1.0\"\r\n}\r\n```\r\n\r\n## Configuration\r\n\r\nTo configure the plugin, create `config.in.php` in the `plugins/jsxc` directory. You can use `config.inc.php.dist` as a reference.\r\n\r\n### JSXC Configuration\r\n\r\nHere you can configure basic XMPP and WebRTC connectivity options, as well as many other parameters. The structure mirrors that of JSXC configuration; please refer to [JSXC documentation](https://rawgit.com/jsxc/jsxc/master/doc/jsxc.options.html) for the full list of options.\r\n\r\nExample:\r\n```\r\n$config['jsxc'] = [\r\n    'xmpp' =\u003e [\r\n        'url' =\u003e 'https://mydomain.foo/http-bind/',\r\n        'domain' =\u003e 'mydomain.foo',\r\n        'resource' =\u003e 'JSXC',\r\n        'overwrite' =\u003e true,\r\n        'onlogin' =\u003e false\r\n    ],\r\n    'RTCPeerConfig' =\u003e [\r\n        'iceServers' =\u003e [\r\n            [\r\n                'urls' =\u003e 'stun:stun.l.google.com:19302'\r\n            ]\r\n        ]\r\n    ]\r\n];\r\n```\r\n\r\n### TURN REST API Configuration\r\n\r\nIf you use a private/corporate TURN server, you probably won't want to expose TURN credentials. This is a well-known problem that has been addressed to some extent by [this draft](https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00). \r\nThe plugin supports generating the so-called ephemeral TURN credentials. For that, you'll need to configure shared cryptographic secret(s):\r\n\r\n```\r\n$config['turn'] = [\r\n    'ttl' =\u003e 86400,\r\n    'servers' =\u003e [\r\n        [\r\n            urls =\u003e 'turn:turn.myserver.foo',\r\n            secret =\u003e 'secret'\r\n        ]\r\n    ]\r\n];\r\n```\r\n\r\nIf TURN REST API is configured, the whole `RTCPeerConfig` section from the JSXC config will be overridden. \r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsxc%2Fjsxc.roundcube","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjsxc%2Fjsxc.roundcube","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsxc%2Fjsxc.roundcube/lists"}