JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site.
Other
Sidebar
Prev
|
Up
|
Next
S2S Get CID Connection State
For internal developer use only.
Contents
Search
Tigase Administration Guide
Tigase XMPP Server 8.0.0 announcement
Major Changes
Kernel and beans configuration
New Configuration File Format
Cluster Node Shutdown Changes
Significant cleanup of code and repositories
BouncyCastle being used for StartTLS
default-virtual-host property changes
All artifacts are signed
Scaled Down Installation Methods
Emojis now supported on Tigase XMPP Servers
XEP-0215 External Service Discovery now supported
XEP-0313 Message Archive Management now supported
XEP-0363 HTTP File Upload now supported
Startup now uses bootstrapping
CAPTCHA system now available for in-band registration
Schema changes
Shrinkable Statistics History
Statistics now available for all modules
Spam Protection
Account Registration Limits Expanded
Accounts created using in-band registration now will use confirmation E-mail
Further Spam prevention
Changes in password storage
Dynamic TLS Buffer
XEP-305 Quickstart now supported
Database Timestamps
Config-type properties have changed
Database Watchdog implemented
Packet statistics expanded
XEP-0016 Behavior changes
Access Control List has new ACL modifiers
Option to ignore schema-version check added
Protection against brute-force attacks
New Minor Features & Behavior Changes
Fixes
Component Changes
AMP
PubSub
http-api
message-archive
MUC
socks5 Proxy
stats
STUN Server
WebSocket
Tigase User Guide
Jabber/XMPP introduction
Jabber/XMPP is Instant Messaging Technology
How to Use Tigase Service
This Article Describes How to use tigase.im Service for Instant Communications
Short instructions:
Long Instructions:
Configuration instructions for Psi
Psi - Initial configuration
Short Instructions How to Add Your First Contact
About Tigase XMPP Server
Robust and reliable
Security
Flexibility
Extensibility
Ease of Use
XMPP Supported Extensions
Core Compliance Suite
Web Compliance Suite
IM Compliance Suite
Mobile Compliance Suite
Non-Compliance Suite Extensions
Licensing and Open Source
Tigase Server Binary Updates
Quick Start Guide
Minimum Requirements
Contents
Installation Using Web Installer
Download and Extract
Start the Server
Verify Tigase is Running
Connect to the Web Installer
Step Through the Installation Process
Restart the Server
Windows Instructions for using Web Installer
Manual Installation in Console Mode
Get the Binary Package
Unpack the Package
Prepare Configuration
Configure tigase.conf
Configure config.tdsl
Step 1: Change config-type
Step 2: Set virtual host
Step 3: Set Administrators
Step 4: Set databases
Install Database
Start the Server
Check if it is Working
Windows Installation
Step 1: Initial Setup
Step 2: Starting Server
2A: Installing as a service
MySQL Database Installation
Tigase Server Network Instructions
A Records
SRV Records
Tigase and Vhosts
Hosting VIA Tigase.me
Checking setup
Ports description
Tigase Script Selection
Configuration: For Linux Distributions using systemd
Configuration: For All Linux Distributions
Gentoo
Mandriva
Redhat
Debian
Running Tigase as a system service
For systemd-based linux distributions
For other linux distributions
Shutting Down Tigase
Shutdown statistics
Shutdown StackTrace Dump
Shutting Down Cluster Nodes
Upgrading to v8.0.0 from v7.1.0
Backup your data
Setup Tigase XMPP Server 8.0.0
Upgrade configuration file
Connect new database
Upgrade Database schema
Help?
Upgrade/Restore with a script [experimental!]
Configuration
DSL file format
Why new format?
What is DSL?
Why DSL?
Setting property
Setting global property
Defining bean
Configuring bean
Format of values
Using values from System Properties and Environment Variables
Computed values
Period / Duration values
Example configuration file in DSL
Default configuration
Startup File for tigase.sh - tigase.conf
Linux Settings for High Load Systems
fs.file-max
net.ipv4.ip_local_port_range
TCP_keepalive
/etc/sysctl.conf
nofile
su and init script
JVM settings and recommendations
Heap Sizing
GC settings
Generations
Minor, Major and Full GC - optimizing
Settings for XMPP
GC settings worth considering
What to use with Machine x, y, z?
Server class machine (non-VM), > 16GB, >= 8 core CPU
VM machine, 8GB of RAM, 4 core CPU equivalent
VM machine with 4GB or less of RAM, and less than 4 core CPU equivalent
Additional resources
Session Manager
Mobile Optimizations
MobileV1
MobileV2
MobileV3
Disabling CSI
A note about Mobile Plugins
threads-pool
Thread Pool factor
Strategy
Virtual Hosts in Tigase Server
Default VHost configuration
Specification for ad-hoc Commands Used to Manage Virtual Domains
Reloading the Domains List from the Database
Adding a New Domain or Updating Existing One
Removing a Virtual Domain From the Server
Virtual Components for the Cluster Mode
Settings for Custom Logging in Tigase
Tigase Advanced Options
Using CAPTCHA for in-band registration
Enabling Empty Nicknames
Enable Silent Ignore on Packets Delivered to Unavailable Resources
Mechanism to count errors within Tigase
Including stream errors
Stream resumption default & max-timeout
Security
XEP-0191: Blocking Command
Account Registration Limits
Brute-force attack prevention
Configuration
Working modes
Permanent ban
Server Certificates
Creating and Loading the Server Certificate in pem Files
Server Certificates
Generating your Own Certificates
Installing/Loading Certificate To the Tigase Server
Certificate From Other Providers
Using one certificate for multiple domains
Installing LetsEncrypt Certificates in Your Linux System
Custom Authentication Connectors
Tigase Auth Connector (DEPRECATED)
Tigase Custom Auth Connector
Drupal Authentication
LDAP Authentication Connector
Configuration of SASL EXTERNAL
Packet Filtering
Domain Based Packet Filtering
Introduction
Configuration
Administration, Rules Management
Implementation
Access Control Lists in Tigase
Database Management
Recommended database versions
Database Watchdog
Using modified database schema
Database Preparation
Schema Utility
Operation & Variables
Operation
Options
Usage
upgrade-schema
install-schema
Options
Query function
destroy-schema
A note about MySQL
Prepare the MySQL Database for the Tigase Server
Configuring from MySQL command line tool
Installing Schemas
Windows instructions:
Configuring From the Linux Shell Command Line
Selective access configuration
Grant access to tigase_user connecting from any network address.
Grant access to tigase_user connecting from localhost.
Grant access to tigase_user connecting from local machine only.
Schema Installation
Configuring MySQL for UTF-8 Support
Other MySQL Settings Worth Considering
Support for emoji and other icons
Prepare the Derby Database for the Tigase Server
Basic Setup
General Approach
Connecting Tigase to database
Prepare the MS SQL Server Database for the Tigase Server
Preparing MS SQL Server Instance
Configuration using MS SQL Server Management Studio
Using Wizards
Using Queries
Import Schema
Configuring from command line tool
Tigase configuration - config.tdsl
JDBC: jTDS vs MS JDBC driver
Prepare the PostgreSQL Database for the Tigase Server
Configuring from PostgreSQL Command Line Tool
Schema Installation
Configuring From the Linux Shell Command Line
Database Schema Installation
Preparing Tigase for MongoDB
Dependencies
Configuration
Configuration of user repository for Tigase XMPP Server
Configuration for MUC
Configuration for PubSub
Configuration for Message Archiving
Schema Description
Tigase XMPP Server Schema
Hashed User Passwords in Database
Shortcut
Full Route
Create a Test User Account
Test User Authentication
Password Encoding Check
Password Encoding Change
Tigase Server and Multiple Databases
Importing User Data
Importing Existing Data
Connecting the Tigase Server to MySQL Database
Integrating Tigase Server with Drupal
Connecting to Drupal Database
PostgreSQL Database Use
PostgreSQL Database Preparation
Server Configuration
Schema Updates
Changes to Schema in v8.0.0
Reasons
Summary of changes
Added support for storage of encrypted password
Using same salt for any subsequent authentications
Disabled usage of stored procedure for authentication
Deprecated API
Deprecated storage procedures
Usage of MD5 hashes of passwords
Enabling and disabling credentials encoders/decoders
Schema changes
Added password reset mechanism
Upgrading from v7.1.x
Tigase Server Schema v7.2 Updates
FOR ALL USERS UPGRADING TO v8.0.0 FROM A v7.0.2 INSTALLATION
Tigase Schema Change for v7.1
Changes to Pubsub Schema
Components
Advanced Message Processing - AMP XEP-0079
First of all: plugins
Secondly: component
Optional parameters
Server Monitoring
Setting Up Remote Monitoring in the Server
What You Need
Activation
Security
JMX
SNMP
HTTP
Retrieving statistics from the server
Retrieving statistics using XMPP
Psi XMPP Client
Retrieving statistics using JMX
JConsole
StatsDumper.groovy
Eventbus
Setup
How it Works
Available Tasks
Configuration
config.tdsl
Subscription Limitations
Configuration via XMPP
Getting the Message
XMPP notification
Sample notification from Eventbus
Mailer Extension
Configuration
Configuration of statistics loggers
Server to Server Protocol Settings
Number of Concurrent Connections
Connection Throughput
Maximum Packet Waiting Time and Connection Inactivity Time
Custom Plugin: Selecting s2s Connection
skip-tls-hostnames
ejabberd-bug-workaround
Tigase Load Balancing
Available Implementations
Configuration Options
SeeOtherHostDB
SeeOtherHostDualIP
EventBus as a source of information
Auxiliary setup options
Enforcing redirection
Configuring hostnames
External Component Configuration
External Component Configuration
Tigase as an External Component
Usage with shared database (since version 8.0.0)
A Simple Case - MUC as an External Component
More Components
Usage with a separate database
A Simple Case - MUC as an External Component
More Components
Load Balancing External Components in Cluster Mode
Load Balancing External Component
External Component and Cluster
Client to Server Communication
Configuration
Connections
new-connections-throttling
Resumption timeout
Packet Redelivery
Tigase External Service Discovery
Setup & Configuration
Using Tigase
Offline Messages
Offline Message Limits
User Limit
Handling of Offline Messages Exceeding Limits
Setting the Limits by User
Example of Setting Limit of Stored Offline Messages to 10
Example of Disabling Offline Message Limit
Storing offline messages without body content
Filtering of offline storage
Disabling Offline Messages
Last Activity
What updates last activity
Persist everything to repository
Tigase Log Guide
install.log
derby.log
etc/config-dump.properties
logs/tigase.log.#
logs/statistics.log.#
logs/tigase.pid
logs/tigase-console.log
Log File Location
Debuging Tigase
Configuration
Non-Tigase packages
Basic System Checks
Add and Manage Domains (VHosts)
Using Admin UI
Adding a new domain
Modifying domain settings
Removing a domain
Using ad-hoc commands
Adding a New Domain
Adding a New User
SSL Certificate Management
Presence Forwarding
Watchdog
Setup
Watchdog Configuration
Logic
Testing
Tips and Tricks
Tigase Tip: Checking the Runtime Environment
Best Practices for Connecting to Tigase XMPP server From Web Browser
BOSH
Tip #1 - BOSH in Cluster Mode Without Load Balancer
WebSocket
Tip #1 - Encrypted WebSocket Connection
Tip #2 - Encrypted WebSocket Connection - Dealing With Multiple VHosts
Licensing
Registering for a License
Manual
Generating Installation ID
Obtaining a Server Code
Obtaining license file
What happens if I do not use a license file or it is expired?
Demo mode
Statistics Sent
Unauthorized use
Manual mode
Tigase Clustering
Configuration
Custom Ports
Custom Port Configuration
Multi-node configuration
Traffic Control
cm-ht-traffic-throttling
cm-see-other-host
Old configuration method
Specifying Specific nodes
Password and Port configuration
Checking Cluster Connections
Established connections
Cluster nodes connected (using XMPP)
Psi XMPP Client
Anonymous Users & Authentication
Anonymous Authentication
Anonymous User Features
Reconnection on Anonymous
Scripting support in Tigase
Scripting Introduction - Hello World!
Loading Script at Run Time
Executing Script
Interaction in Scripts
Automatic Scripts Loading at Startup Time
Tigase Scripting Version 4.4.x Update for Administrators
Tigase and Python
Installation
Writing Python Scripts
Appendix I - Statistics description
Data source statistics
User repository statistics of {repo}
Auth repository statistics of {repo}
Statistics common to custom {compname} component repositories
Statistics common to components
Component statistics
AMP
bosh
c2s
cl-comp
eventbus
message-archive
message-router
monitor
muc
proxy
pubsub
repo-factory
rest
s2s
sess-man
vhost-man
ws2s
Appendix II - Properties Guide
General
admins
Certificate Container
ssl-certs-location
ssl-def-cert-domain
Component
Ports
config-type
debug-packages
debug
monitoring
plugins
priority-queue-implementation
roster-implementation
s2s-secret
scripts-dir
ssl-container-class
stats
stats-history-size
stats-history-interval
stats-logger
frequency
stats-file-logger
frequency
file configuration
Database logger
Example configuration block
stream-error-counter
stringprep-processor
test
tls-jdk-nss-bug-workaround-active
trusted
Repository
authRepository
Configuration Values:
pool-size
cls
authRepository
MSSQL
MongoDb
pool-size
Cluster
cl-comp
connect-all
cluster-mode
cluster-nodes
User connectivity
bosh-close-connection
bosh-extra-headers-file
client-access-policy-file
client-port-delay-listening
cross-domain-policy-file
domain-filter-policy
see-other-host
watchdog_timeout
watchdog_delay
watchdog_ping_type
ws-allow-unmasked-frames
External
bind-ext-hostnames
default-virtual-host
ext
Performance
cm-ht-traffic-throttling
cm-traffic-throttling
elements-number-limit
hardened-mode
max-queue-size
net-buff-high-throughput
net-buff-standard
nonpriority-queue
VHost / domain
vhost-anonymous-enabled
vhost-disable-dns-check
vhost-max-users
vhost-message-forward-jid
vhost-presence-forward-jid
vhost-register-enabled
vhost-tls-required
Tigase Server Extras - mDNS support
Overview
Enabling mDNS
Using different domain name
Forcing single server for domain
HTTP API component
Available modules
Admin UI module
Index module
REST module
Server status module
Setup module
Web UI module
User Status Endpoint module
Common module configuration
Enabling/disabling module
Context path
List of virtual hosts
Complex example
Module specific configuration
Rest Module
API keys
DNS Web Service module
Parameters
Discover way to connect to XMPP server hosting sure.im domain.
Enabling password reset mechanism
Admin UI Guide
A Note about REST
General overview of the UI
Configuration
Example Scripts
Notifications
Other
Activate log tracker for a user
Add SSL certificate
Add listener script
Add Monitor Task
Add Monitor Timer Task
Add New Item - ext
Add New Item - Vhost
Change user inter-domain communication permission
Connections Time
Create Node
DNS Query
Default config - Pubsub
Default room config
Delete Monitor Task
Delete Node
Deleting ALL Nodes
Fix User’s Roster
Fix User’s Roster on Tigase Cluster
Get User Roster
Get any file
Get Configuration File
Get config.tdsl File
Get list available commands
Load test
Load Errors
New command script
OAuth Credentials
Pre-Bind BOSH user session
Publish item to node
Read ALL nodes
Rebuild database
Reload component repository
Remove an item
Remove command script
Remove listener script
Remove room
Retrieve items
S2S Bad State Connections
S2S Reset Bad State Connections
S2S Get CID Connection State
Subscribe to a node
Unsubscribe from node
Update item configuration
vhost-man
Update user roster entry
Update user roster entry extended version
Scripts
New Command Script
Remove Command Script
Statistics
Get User Statistics
Get Active User List
Get list of idle users
Get list of online users
Get number of active users
Get number of idle users
Get top active users
Users
Add User
Change User Password
Delete User
End user session
Get User Info
Get registered user list
Modify User
Tigase Web Client
Chat
Discovery
Management
Configuration
Notifications
Other
Activate log tracker for a user
Add SSL certificate
Add Monitor Task
Add Monitor Timer Task
Add New Item - ext
Add New Item - Vhost
Change user inter-domain communication permission
Connections Time
DNS Query
Default config - Pubsub
Default room config
Delete Monitor Task
Fix User’s Roster
Fix User’s Roster on Tigase Cluster
Get User Roster
Get any file
Get Configuration File
Get config.tdsl File
Load Errors
New command script - Monitor
New command script - MUC
OAUth credentials
Pre-Bind BOSH user session
Reload component repository
Scripts
Statistics
Get User Statistics
Get Active User List
Get list of idle users
Get list of online users
Get number of active users
Get number of idle users
Get top active users
Users
Add New User
Change user password
Delete user
Get User Info
Get registered user list
Modify User
HTTP File Upload component
Enabling HTTP File Upload Component
Metadata repository
DummyFileUploadRepository
JDBCFileUploadRepository
Storage
DirectoryStore
Logic
URI template format
File upload expiration
Examples
Complex configuration example
Example configuration for clustering with HA
HTTP server
Dependencies
Configuration Properties
Additional properties of embedded HTTP server
Examples
HTTPS on port 8443 with SSL certificate for example.com
Changing port from 8080 to 8081
Usage of Jetty HTTP server as HTTP server
Standalone
OSGi
Tigase Message Archiving Component
Tigase Message Archiving Component
Announcement
Major changes
Database schema changes
New features
Support for Message Archive Management protocol
Support for using separate database for different domains
Additional features
Querying in all messages
Querying by part of message body
Example query requests
Example 1
Example 2
Querying by tags
Querying/retrieving list of messages or collections
Example 1
Example 2:
Retrieving list of tags used by user starting with some text
Automatic archiving of MUC messages
Database
Preparation of database
Upgrade of database schema
Schema description
Table tig_ma_jids
Table tig_ma_msgs
Table tig_ma_tags
Table tig_ma_msgs_tags
Configuration
Custom Database
XEP-0136 Support
Support for MAM
Setting default value of archiving level for message on a server
Setting required value of archiving level for messages on a server
Enabling support for tags
Saving Options
Configuration of automatic archiving of MUC messages
Purging Information from Message Archive
Configuration of number of days in VHost
Using separate store for archived messages
Setting Pool Sizes
Message Tagging Support
Activating Tagging
Usage
Usage
XEP-0136 Field Values
Manual Activation
Limitations
Tigase PubSub Component
PubSub Component
Announcement
Major changes
Database schema changes
Changes in REST API
New features
Support for using separate database for different domains
Support for MAM
Configuration
Pubsub naming
Configure Roster Maximum size
Store Full XML of Last Presence
Requirements
Using separate store
Enabling PEP support
Enabling REST API
Changing nodes cache size
Enable sending last published item on presence
Tune handling of low memory
Disable automatic subscription of node creator
Database
Preparation of database
Upgrade of database schema
Schema description
Table tig_pubsub_service_jids
Table tig_pubsub_jids
Table tig_pubsub_nodes
Table tig_pubsub_affiliations
Table tig_pubsub_subscriptions
Table tig_pubsub_items
PubSub Schema Changes
PubSub 3.2.0 Changes
Upgrading older installations (pre-v3.0.0 Schema)
Prepare Old Database for Upgrade
Update Tigase PubSub Component
Load New Schema
Execute Migration Utility
Finish
Features
AdHoc Commands
Create a Node
Delete a Node
Subscribe to a Node
Unsubscribe to a Node
Publish an item to a Node
PubSub Node Presence Protocol
Log in to Pubsub Node
Log out from PubSub Node
Retrieving list of all Node Subscribers
Configuration
Create node
Add sess-man as publisher
config.tdsl configuration
Usage
Managing Subscriptions
Add new Subscriber
Remove Subscriber
REST API
Create a node
GET
POST
Using XML
Using JSON
Delete a node
GET
POST
Using XML
Using JSON
Subscribe to a node
GET
POST
Using XML
Using JSON
Unsubscribe from a node
GET
POST
Using XML
Using JSON
Publish an item to a node
GET
POST
Using XML
with XML payload
with JSON payload
Using JSON
with XML payload
with JSON payload
Delete an item from a node
GET
POST
Using XML
Using JSON
List available nodes
GET
List published items on node
GET
POST
Using XML
Using JSON
Retrieve item published on node
GET
POST
Using XML
Using JSON
Retrieve user subscriptions
GET
POST
Using XML
Using JSON
AdHoc Commands
Create a Node
Delete a Node
Subscribe to a Node
Unsubscribe to a Node
Publish an item to a Node
PubSub Node Presence Protocol
Log in to Pubsub Node
Log out from PubSub Node
Retrieving list of all Node Subscribers
Offline Message Sink
Configuration
Create node
Add sess-man as publisher
config.tdsl configuration
Usage
Managing Subscriptions
Add new Subscriber
Remove Subscriber
REST API
Create a node
GET
POST
Using XML
Using JSON
Delete a node
GET
POST
Using XML
Using JSON
Subscribe to a node
GET
POST
Using XML
Using JSON
Unsubscribe from a node
GET
POST
Using XML
Using JSON
Publish an item to a node
GET
POST
Using XML
with XML payload
with JSON payload
Using JSON
with XML payload
with JSON payload
Delete an item from a node
GET
POST
Using XML
Using JSON
List available nodes
GET
List published items on node
GET
POST
Using XML
Using JSON
Retrieve item published on node
GET
POST
Using XML
Using JSON
Retrieve user subscriptions
GET
POST
Using XML
Using JSON
Limitations
Addressing
Tigase Socks5 Proxy
Overview
Installation
Database Preparation
Edit Existing Database
Create New Database
Configuration
Enabling proxy
remote-addresses
Port settings
Enabling limits
DummyVerifier
LimitsVerifier
Configuring limits
Individual Limits
Using a separate database
Performance
Tigase Push Component
Tigase Push Component
Workflow
Enabling notifications
Receiving notifications
Configuration
Enabling component
Enabling push notifications for offline messages
Enabling push notifications for messages received when all resources are AWAY/XA/DND
Usage
Sending notifications
Registering device
Unregistering device
Providers
Tigase Push Component - FCM provider
Overview
Configuration
Enabling provider
Setting FCM credentials
Connection pool
Tigase Push Component - APNs provider
Overview
Configuration
Enabling provider
Setting APNs credentials
Connection pool
Tigase STUN Component
Tigase STUN Component
What is STUN?
Requirements
Configuration
Setting descriptions
Logback configuration
Tigase SPAM Filter
Overview
Configuration
Changing active SPAM filters
Sending error when packet is dropped
Enabling logging of dropped messages
Filters
Same long message body
Message body length
Number of allowed message with same body
Size of counters cache
Error message and missing <error/> child
Groupchat messages sent to bare JID
Known spammers
Cache time
Disabling account
Print list of detected spammers
Frequency of printing list of spammers
Presence subscription filter
Number of allowed subscription requests per minute
Search Highlighter (On/Off)
