Skip to content

xmppjs/console

Repository files navigation

console

XMPP console, terminal and web interfaces.

Install

npm install -g @xmpp/console

Usage

Usage
  $ xmpp-console [service]

Options
  --port, -p 8080 port for the web interface
  --web, -w use web interface
  --no-open, prevents opening the url for the web interface
  --type, -t client (default) or component
  --username, -u the username for authentication
  --password, -p the password for authentication
  --domain, -d the service domain

Examples
  $ xmpp-console localhost (auto)
  $ xmpp-console xmpp://localhost[:5222] (classic XMPP)
  $ xmpp-console xmpps://localhost[:5223] (direct TLS)
  $ xmpp-console ws://localhost:5280/xmpp-websocket (WebSocket)
  $ xmpp-console wss://localhost:52801/xmpp-websocket (Secure WebSocket)
  $ xmpp-console xmpp://component.localhost[:5347] --type component (component)

Interfaces

Terminal

The terminal interface supports component and client connection (TCP and WebSocket).

Web

The Web interface only supports WebSocket client connection at the moment.

It is possible to use it locally with xmpp-console --web (see Usage) or deploy it with

$ git clone https://github.com/xmppjs/console.git
$ cd console
$ npm install
$ npm run build

and use your HTTP server to serve console/public/.