Chapril/xmpp.chapril.org-conversejs
Chapril
/
xmpp.chapril.org-conversejs
24
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
xmpp.chapril.org-conversejs/README.md

189 lines
10 KiB
Markdown
Raw Permalink Normal View History

Add a readme logo
2020-04-29 09:51:56 +02:00
<h2 align="center">
<a href="https://conversejs.org" target="_blank" rel="noopener">
Fixed header image and typo
2020-06-08 17:24:08 +02:00
<img alt="Converse.js" src="https://github.com/conversejs/converse.js/blob/master/logo/readme.png" width="480">
Add a readme logo
2020-04-29 09:51:56 +02:00
</a>
</h2>
Change readme into markdown
2016-05-20 11:46:53 +02:00
Fix path to chat badge
2021-08-28 22:39:46 +02:00
[![XMPP Chat](https://conference.conversejs.org/muc_badge/discuss@conference.conversejs.org)](https://inverse.chat/#converse/room?jid=discuss@conference.conversejs.org)
Replace TravisCI badge with Github Actions badge
2022-02-24 06:19:52 +01:00
[![CI Tests](https://github.com/conversejs/converse.js/actions/workflows/karma-tests.yml/badge.svg)](https://github.com/conversejs/converse.js/actions/workflows/karma-tests.yml)
Add weblate badge
2017-03-15 12:04:10 +01:00
[![Bountysource bounties](https://img.shields.io/bountysource/team/converse.js/activity.svg?maxAge=2592000)](https://www.bountysource.com/teams/converse.js/issues?tracker_ids=194169)
[![Translation status](https://hosted.weblate.org/widgets/conversejs/-/svg-badge.svg)](https://hosted.weblate.org/engage/conversejs/?utm_source=widget)
Change readme into markdown
2016-05-20 11:46:53 +02:00
Add new screenshots of Converse 4 and update backers list
2018-09-23 21:26:03 +02:00
[Converse](https://conversejs.org) is a web based [XMPP/Jabber](https://xmpp.org) chat client.
Change readme into markdown
2016-05-20 11:46:53 +02:00
Add new screenshots of Converse 4 and update backers list
2018-09-23 21:26:03 +02:00
You can either use it as a webchat app, or you can integrate it into your own website.
Add 404 for OPTIONS request to troubleshooting section
2018-09-24 09:52:09 +02:00
It's 100% client-side JavaScript, HTML and CSS and the only backend required
Add new screenshots of Converse 4 and update backers list
2018-09-23 21:26:03 +02:00
is a modern XMPP server.
Change readme into markdown
2016-05-20 11:46:53 +02:00
Mention liberapay
2017-12-06 11:40:04 +01:00
Please support this project via [Patreon](https://www.patreon.com/jcbrand) or [Liberapay](https://liberapay.com/jcbrand)
Mention patreon
2017-12-05 14:11:48 +01:00
Mention the new CDN
2016-06-21 09:07:22 +02:00
## Demo
Change readme into markdown
2016-05-20 11:46:53 +02:00
Add new screenshots of Converse 4 and update backers list
2018-09-23 21:26:03 +02:00
Converse is hosted and can be used at [https://conversejs.org](https://conversejs.org).
Add screenshots to the readme
2017-06-14 15:42:25 +02:00
A demo showing anonymous login is available at [https://conversejs.org/demo/anonymous.html](https://conversejs.org/demo/anonymous.html)
and a demo which shows how you can embed a single chat room into a page is
avialable at [https://conversejs.org/demo/embedded.html](https://conversejs.org/demo/embedded.html).
More visual README for users * Add screenshot for embedded view mode * Add Pàdé
2019-12-04 15:17:13 +01:00
## Documentation
The developer/integrator documentation can be found at [https://conversejs.org/docs/html](https://conversejs.org/docs/html).
You'll probably want to begin with the [quickstart guide](https://conversejs.org/docs/html/quickstart.html),
which shows you how to use the CDN (content delivery network) to quickly get a demo up and running.
## Converse modes
### Overlay
Add screenshots to the readme
2017-06-14 15:42:25 +02:00
More visual README for users * Add screenshot for embedded view mode * Add Pàdé
2019-12-04 15:17:13 +01:00
In overlay mode, Converse appears overlayed chats on top of the website.
Mention inverse in the readme and index.html
2017-07-05 13:02:36 +02:00
Rename image links to use dashes For cache invalidation on Github
2021-08-29 14:20:31 +02:00
![Screenshot of Converse in overlay mode](https://conversejs.org/screenshots/Converse-overlayed.png)
More visual README for users * Add screenshot for embedded view mode * Add Pàdé
2019-12-04 15:17:13 +01:00
### Fullpage
In fullpage mode, Converse behaves like a single-page app that covers the whole browser viewport.
Add screenshots to the readme
2017-06-14 15:42:25 +02:00
Release 9.1.0
2022-04-02 16:28:01 +02:00
![Screenshot of Converse 9.0.0 in fullpage mode](https://conversejs.org/screenshots/Converse-fullscreen.png)
### Dark mode
![Screenshot of Converse 9.1.0 with a dark theme](https://conversejs.org/screenshots/Converse-Dracula-Theme.png)
Mention the new CDN
2016-06-21 09:07:22 +02:00
More visual README for users * Add screenshot for embedded view mode * Add Pàdé
2019-12-04 15:17:13 +01:00
### Embedded
Mention the new CDN
2016-06-21 09:07:22 +02:00
More visual README for users * Add screenshot for embedded view mode * Add Pàdé
2019-12-04 15:17:13 +01:00
In embedded mode, Converse can be embedded into an element in the DOM.
Mention the new CDN
2016-06-21 09:07:22 +02:00
Rename image links to use dashes For cache invalidation on Github
2021-08-29 14:20:31 +02:00
![Screenshot of Converse in embedded mode](https://conversejs.org/screenshots/Converse-embedded.png)
Mention the new CDN
2016-06-21 09:07:22 +02:00
## Features
[DOC] update integration and features
2018-09-08 02:16:04 +02:00
- Available as overlayed chat boxes or as a fullscreen application. See [inverse.chat](https://inverse.chat) for the fullscreen version.
Add support for XEP-0424 and XEP-0425 - Add support for switching ephemerality after message creation - Move more methods from ChatBox and ChatRoom to utils/stanza.js - Rename 'ephemeral' to 'is_ephemeral' since it's a boolean
2019-09-24 15:33:41 +02:00
- Custom status messages
- Desktop notifications
Update repo paths
2018-03-17 00:40:03 +01:00
- A [plugin architecture](https://conversejs.org/docs/html/plugin_development.html) based on [pluggable.js](https://conversejs.github.io/pluggable.js/)
Change readme into markdown
2016-05-20 11:46:53 +02:00
- Chat statuses (online, busy, away, offline)
Add support for XEP-0424 and XEP-0425 - Add support for switching ephemerality after message creation - Move more methods from ChatBox and ChatRoom to utils/stanza.js - Rename 'ephemeral' to 'is_ephemeral' since it's a boolean
2019-09-24 15:33:41 +02:00
- Anonymous logins, see the [anonymous login demo](https://conversejs.org/demo/anonymous.html)
Add the ability to show/hide unfurls
2021-03-05 15:00:01 +01:00
- URL Previews (requires server support, for example [mod_ogp](https://modules.prosody.im/mod_ogp.html)
Add support for XEP-0424 and XEP-0425 - Add support for switching ephemerality after message creation - Move more methods from ChatBox and ChatRoom to utils/stanza.js - Rename 'ephemeral' to 'is_ephemeral' since it's a boolean
2019-09-24 15:33:41 +02:00
- Translated into over 30 languages
Change readme into markdown
2016-05-20 11:46:53 +02:00
Document supported XEPs. Updates #1037
2020-04-24 15:13:40 +02:00
### Supported XMPP Extensions
- [RFC-7395](https://tools.ietf.org/html/rfc7395) XMPP Subprotocol support for WebSocket
- [XEP-0004](https://xmpp.org/extensions/xep-0004.html) Data Forms
- [XEP-0030](https://xmpp.org/extensions/xep-0030.html) Service discovery
- [XEP-0045](https://xmpp.org/extensions/xep-0045.html) Multi-user chat rooms
- [XEP-0048](https://xmpp.org/extensions/xep-0048.html) Bookmarks
- [XEP-0050](https://xmpp.org/extensions/xep-0050.html) Ad-Hoc Commands
- [XEP-0054](https://xmpp.org/extensions/xep-0054.html) VCard-temp
- [XEP-0059](https://xmpp.org/extensions/xep-0059.html) Result Set Management
- [XEP-0060](https://xmpp.org/extensions/xep-0060.html) Publish-Subscribe (limited support)
- [XEP-0066](https://xmpp.org/extensions/xep-0066.html) Out of Band Data
- [XEP-0077](https://xmpp.org/extensions/xep-0077.html) In-band registration
- [XEP-0085](https://xmpp.org/extensions/xep-0085.html) Chat State Notifications
Add XEP-0115 to XEP list Based on a message from JC in the chat.
2021-03-14 00:54:19 +01:00
- [XEP-0115](https://xmpp.org/extensions/xep-0115.html) Entity Capabilities
Document supported XEPs. Updates #1037
2020-04-24 15:13:40 +02:00
- [XEP-0124](https://xmpp.org/extensions/xep-0124.html) Bidirectional-streams Over Synchronous HTTP (BOSH)
- [XEP-0144](https://xmpp.org/extensions/xep-0144.html) Roster item exchange
Update README.md - corrects typo
2020-09-02 12:37:02 +02:00
- [XEP-0156](https://xmpp.org/extensions/xep-0156.html) Discovering Alternative XMPP Connection Methods
Document supported XEPs. Updates #1037
2020-04-24 15:13:40 +02:00
- [XEP-0163](https://xmpp.org/extensions/xep-0163.html) Personal Eventing Protocol (limited support)
- [XEP-0184](https://xmpp.org/extensions/xep-0184.html) Message Receipt
- [XEP-0198](https://xmpp.org/extensions/xep-0198.html) Stream Management
- [XEP-0199](https://xmpp.org/extensions/xep-0199.html) XMPP Ping
- [XEP-0203](https://xmpp.org/extensions/xep-0203.html) Delayed Delivery
- [XEP-0206](https://xmpp.org/extensions/xep-0206.html) XMPP Over BOSH
- [XEP-0245](https://xmpp.org/extensions/xep-0245.html) The /me Command
- [XEP-0249](https://xmpp.org/extensions/xep-0249.html) Direct MUC Invitations
- [XEP-0280](https://xmpp.org/extensions/xep-0280.html) Message Carbons
- [XEP-0297](https://xmpp.org/extensions/xep-0297.html) Stanza Forwarding (limited support)
- [XEP-0308](https://xmpp.org/extensions/xep-0308.html) Last Message Correction
- [XEP-0313](https://xmpp.org/extensions/xep-0313.html) Message Archive Management
Register a XEP-0316 MEP handler Add caps element to the MUC join presence, so that the MUC MEP node can know whether we're interested in receiving MEP messages. Create info messages for any `conference-info` tags that contain `activity` tags. Check for both `headline` and `normal` MEP messages (even though the XEP only show `headline` examples), since `normal` messages can be archived in MAM, but `headline` ones not. Update the XEP-0372 reference-parsing code to take the `anchor` attribute into consideration, specifically to check which text element the reference applies to. Add support for rendering XEP-0372 mentions in "info" messages and for triggering HTML5 Desktop notifications for such mentions. Background: ----------- XEP-0316 describes a way for a MUC to send out PEP-like messages to MUC participants. This feature can be used to describe custom activity happening in the MUC.
2021-08-13 10:18:24 +02:00
- [XEP-0316](https://xmpp.org/extensions/xep-0316.html) MUC Eventing protocol (limited support)
Document supported XEPs. Updates #1037
2020-04-24 15:13:40 +02:00
- [XEP-0317](https://xmpp.org/extensions/xep-0317.html) Hats (limited support)
- [XEP-0333](https://xmpp.org/extensions/xep-0333.html) Chat Markers (limited support)
- [XEP-0352](https://xmpp.org/extensions/xep-0352.html) Client State Indication
- [XEP-0357](https://xmpp.org/extensions/xep-0357.html) Push Notifications
- [XEP-0359](https://xmpp.org/extensions/xep-0359.html) Unique and Stable Stanza IDs
- [XEP-0363](https://xmpp.org/extensions/xep-0363.html) HTTP File Upload
- [XEP-0372](https://xmpp.org/extensions/xep-0372.html) References
- [XEP-0382](https://xmpp.org/extensions/xep-0382.html) Spoiler messages
- [XEP-0384](https://xmpp.org/extensions/xep-0384.html) OMEMO Encryption
Add support for XEP-0393 message styling Fixes #1083 Directives are rendered as templates and their bodies are MessageText instances. We thereby achieve the necessary nesting of directives (and other rich elements inside directives) by letting each directive body render itself similarly to how the whole message body is rendered.
2020-10-16 09:02:12 +02:00
- [XEP-0393](https://xmpp.org/extensions/xep-0393.html) Message styling
Document supported XEPs. Updates #1037
2020-04-24 15:13:40 +02:00
- [XEP-0422](https://xmpp.org/extensions/xep-0422.html) Message Fastening (limited support)
- [XEP-0424](https://xmpp.org/extensions/xep-0424.html) Message Retractions
- [XEP-0425](https://xmpp.org/extensions/xep-0425.html) Message Moderation
WIP: Add support for XEP-437: Room Activity Indicators - Send marker for last message before leaving and before subscribing to RAI - clear cache of RAI-subscribed domains on reconnection
2020-12-08 14:51:04 +01:00
- [XEP-0437](https://xmpp.org/extensions/xep-0437.html) Room Activity Indicators
Register a XEP-0316 MEP handler Add caps element to the MUC join presence, so that the MUC MEP node can know whether we're interested in receiving MEP messages. Create info messages for any `conference-info` tags that contain `activity` tags. Check for both `headline` and `normal` MEP messages (even though the XEP only show `headline` examples), since `normal` messages can be archived in MAM, but `headline` ones not. Update the XEP-0372 reference-parsing code to take the `anchor` attribute into consideration, specifically to check which text element the reference applies to. Add support for rendering XEP-0372 mentions in "info" messages and for triggering HTML5 Desktop notifications for such mentions. Background: ----------- XEP-0316 describes a way for a MUC to send out PEP-like messages to MUC participants. This feature can be used to describe custom activity happening in the MUC.
2021-08-13 10:18:24 +02:00
- [XEP-0453](https://xmpp.org/extensions/xep-0453.html) DOAP Usage in XMPP
Add XEP-0454 support for encrypting files Fixes #1182
2021-07-01 12:57:28 +02:00
- [XEP-0454](https://xmpp.org/extensions/xep-0454.html) OMEMO Media sharing
Document supported XEPs. Updates #1037
2020-04-24 15:13:40 +02:00
Added Chimeverse and UT app
2019-11-30 00:09:06 +01:00
## Integration into other servers and frameworks
Change readme into markdown
2016-05-20 11:46:53 +02:00
Mention Ejabberd's Converse module
2022-04-28 16:08:08 +02:00
### XMPP servers
- **[Openfire](https://www.igniterealtime.org/projects/openfire/index.jsp)**: [inverse.jar](https://www.igniterealtime.org/projects/openfire/plugins.jsp)
- **[Prosody](https://prosody.im/)**: [mod_conversejs](https://modules.prosody.im/mod_conversejs.html)
- **[Ejabberd](https://ejabberd.im/)**: [mod-conversejs](https://docs.ejabberd.im/admin/configuration/modules/#mod-conversejs)
### Other
Update documentation in anticipation of next release Site HTML: make links relative
2020-09-18 11:19:44 +02:00
- **[Alfresco](https://www.alfresco.com)**: [alfresco-js-chat-share](https://github.com/keensoft/alfresco-js-chat-share)
Fix some more links to use HTTPS. (#1136) * Actually fix the correct link to the room. * Update the other opcode.com links to HTTPS. * Update all other links to HTTPS. * Update all links to HTTPS also in the README. The mailing list and Patternslib don’t support it yet.
2018-07-21 08:20:40 +02:00
- **[Django](https://www.djangoproject.com)**: [django-conversejs](https://pypi.python.org/pypi/django-conversejs) or [django-xmpp](https://github.com/fpytloun/django-xmpp)
Update documentation in anticipation of next release Site HTML: make links relative
2020-09-18 11:19:44 +02:00
- **[Elgg](https://elgg.org)**: [plugin](https://elgg.org/plugins/2997196)
- **[Friendica](https://friendi.ca)**: [converse](https://github.com/friendica/friendica-addons/tree/master/xmpp/converse)
[DOC] update integration and features
2018-09-08 02:16:04 +02:00
- **[Patternslib](http://patternslib.com)**: [patterns.converse](https://github.com/jcbrand/patterns.converse)
- **[Plone](https://plone.com)**: [collective.converse](https://github.com/collective/collective.converse)
Update documentation in anticipation of next release Site HTML: make links relative
2020-09-18 11:19:44 +02:00
- **[Pàdé](https://www.igniterealtime.org/projects/pade/index.jsp)**: [Pàdé](https://www.igniterealtime.org/projects/pade/index.jsp)
- **[Roundcube](https://roundcube.net)**: [roundcube-converse.js-xmpp-plugin](https://github.com/devurandom/roundcube-converse.js-xmpp-plugin)
- **[Ruby on Rails](https://rubyonrails.org)**: [conversejs-rails](https://github.com/mikemarsian/conversejs-rails)
Fix some more links to use HTTPS. (#1136) * Actually fix the correct link to the room. * Update the other opcode.com links to HTTPS. * Update all other links to HTTPS. * Update all links to HTTPS also in the README. The mailing list and Patternslib don’t support it yet.
2018-07-21 08:20:40 +02:00
- **[Tiki Wiki CMS Groupware](https://tiki.org)**: [built-in optional feature](https://doc.tiki.org/XMPP)
Update documentation in anticipation of next release Site HTML: make links relative
2020-09-18 11:19:44 +02:00
- **[Wordpress](https://wordpress.org)**: [ConverseJS](https://wordpress.org/plugins/conversejs/)
Change readme into markdown
2016-05-20 11:46:53 +02:00
Mention the new CDN
2016-06-21 09:07:22 +02:00
## Tests
Change readme into markdown
2016-05-20 11:46:53 +02:00
Update Jasmine link (#696)
2016-10-07 10:35:57 +02:00
We use behavior-driven tests written with [jasmine.js](https://jasmine.github.io/).
Change readme into markdown
2016-05-20 11:46:53 +02:00
Fixed header image and typo
2020-06-08 17:24:08 +02:00
Run `make check` to execute all the tests.
Change readme into markdown
2016-05-20 11:46:53 +02:00
Mention the new CDN
2016-06-21 09:07:22 +02:00
## Licence
Change readme into markdown
2016-05-20 11:46:53 +02:00
`Converse.js` is released under the [Mozilla Public License (MPL)](https://www.mozilla.org/MPL/2.0/index.txt).
Remove the need for emojione
2018-09-03 14:06:18 +02:00
## Attribution
Emoji images are courtesy of [Twemoji](https://emojitwo.github.io/).
Mention the new CDN
2016-06-21 09:07:22 +02:00
## Support
Change readme into markdown
2016-05-20 11:46:53 +02:00
Update repo paths
2018-03-17 00:40:03 +01:00
Issues can be logged on the [Github issue tracker](https://github.com/conversejs/converse.js/issues).
Mention donations on readme
2018-01-29 16:06:07 +01:00
## Donations
A heartfelt thanks for everyone who has supported this project over the years.
Many people have contributed testing, bugfixes, features and corrections.
Add talentplot as sponsor
2019-02-05 21:50:30 +01:00
We accept donations via [Patreon](https://www.patreon.com/jcbrand) and [Liberapay](https://liberapay.com/jcbrand).
Add mailbox.org as sponsor
2021-03-05 15:23:38 +01:00
## Sponsors
Don't show list dots for README sponsors
2021-03-08 09:35:44 +01:00
<p>
Add new sponsor BairesDev
2023-06-05 16:53:49 +02:00
<a href="https://bairesdev.com/sponsoring-open-source-projects/?utm_source=conversejs" target="_blank" rel="noopener">
<img alt="BairesDev" src="https://raw.githubusercontent.com/conversejs/media/main/logos/bairesdev-primary.png" width="200">
Add links to sponsor sites and show as list
2021-03-05 18:51:45 +01:00
</a>
Don't show list dots for README sponsors
2021-03-08 09:35:44 +01:00
</p>
<p>
Add new sponsor BairesDev
2023-06-05 16:53:49 +02:00
<a href="https://blokt.com?utm_source=conversejs" target="_blank" rel="noopener">
<img alt="Blokt Crypto & Privacy" src="https://raw.githubusercontent.com/conversejs/converse.js/541613d1fea8aef364af00180f60e959162e5e4b/logo/blokt.png" width="200">
Add links to sponsor sites and show as list
2021-03-05 18:51:45 +01:00
</a>
Don't show list dots for README sponsors
2021-03-08 09:35:44 +01:00
</p>
Add Prime Sound as sponsor
2022-02-14 14:57:58 +01:00
<p>
<a href="https://primesound.org/?utm_source=conversejs" target="_blank" rel="noopener">
<img alt="Prime Sound" src="https://raw.githubusercontent.com/conversejs/media/main/logos/primesound.png" width="200">
</a>
</p>
Add new sponsor BairesDev
2023-06-05 16:53:49 +02:00
<p>
<a href="https://www.keycdn.com?utm_source=conversejs" target="_blank" rel="noopener">
<img alt="KeyCDN" src="https://raw.githubusercontent.com/conversejs/converse.js/541613d1fea8aef364af00180f60e959162e5e4b/logo/keycdn.png" width="200">
</a>
</p>