Message Queuing

All Plugins / Core / Mq

Identity Card

StatusCore
Plugin LabelMessage Queuing
Short DescriptionMQ Abstraction for dynamic dispatching
Plugin Identifiercore.mq
AuthorCharles du Jeu
Urldocs/references/plugins/core/mq
Dependenciescore.notifications

Documentation

Message Queuing is an instant-messaging system allowing the client applications (like the Web GUI) to be informed in real-time of the server changes: documents movements, new events/alerts published in feed, etc. Although quite powerfull, it relies on a standard setup on the regular polling of the server. Web Clients register to a given temporary channel, and check events from this channel on a regular basis.

Thus, if this seems to downgrade the performance of your server, you may consider switching on the Web Socket server instead. With that technology, modern browsers will just connect once to the WebSocket and receive news from the server in real-time, without polling. You can start and monitor the WebSocket server from this Settings pane, make sure to have the Command Line active in the Pydio Main Options.

Plugin parameters

LabelDescriptionTypeDefault
same
booster_internal_connection
customHiddensame
custom
booster_internal_connection
customHiddencustom
Internal Host (if LAN IP is different from outside-world IP).
BOOSTER_INTERNAL_HOST
Internal HostString127.0.0.1
Internal Port (if LAN Port is different from outside-world Port).
BOOSTER_INTERNAL_PORT
Internal HostString8090
same
server_internal_url
customHiddensame
custom
server_internal_url
customHiddencustom
Pydio Server internal URL
SERVER_INTERNAL_ADDRESS
Pydio Server URL, if LAN IP is different from outside-world IP. Set up full http url here, including http:// or https://String
same
booster_ws_advanced
sameHiddensame
custom
booster_ws_advanced
customHiddencustom
WS Hostname
WS_HOST
WebSocket hostStringlocalhost
WS Port
WS_PORT
WebSocket portString8090
WS Hostname (internal)
WS_HOST_INTERNAL
WebSocket host (internal)Stringlocalhost
WS Port (internal)
WS_PORT_INTERNAL
WebSocket port (internal)String8090
WS Client SSL
WS_SECURE
WebSocket secureBooleanfalse
same
booster_upload_advanced
sameHiddensame
custom
booster_upload_advanced
customHiddencustom
Upload Server host
UPLOAD_HOST
Upload Server hostStringlocalhost
Upload Server port
UPLOAD_PORT
Upload Server portString8090
Upload Server host (internal)
UPLOAD_HOST_INTERNAL
Upload Server host (internal)Stringlocalhost
Upload Server port (internal)
UPLOAD_PORT_INTERNAL
Upload Server port (internal)String8090
Upload Server secure
UPLOAD_SECURE
Upload Server secureBooleanfalse
Main Configurations
WebSocket Server
WS_ACTIVE
WebSocket Server provides a server-to-client messaging feature, avoiding regular polling from browsers and sync applications, thus reducing the server load.Booleanfalse
Upload Server
UPLOAD_ACTIVE
Pydio Upload Server is a unique feature used to delegate file uploads to our dedicated binary, that will send the files directly to the storage.Boolean
Host
BOOSTER_MAIN_HOST
HostString127.0.0.1
Port
BOOSTER_MAIN_PORT
PortString8090
SSL
BOOSTER_MAIN_SECURE
Use secure connectionBooleantrue
NSQ Host
NSQ_HOST
NSQ Host for internal messaging. Leave default value if booster is on the same serverString0.0.0.0
NSQ Port
NSQ_PORT
NSQ Port for internal messagingString4150
Internal Connection *
BOOSTER_INTERNAL_CONNECTION
If different from default host/portGroup_switch:booster_internal_connectionsame
Server Internal URL *
SERVER_INTERNAL_URL
Use this if the booster needs to communicate with the server through a different host/port than the value defined in Application Core OptionsGroup_switch:server_internal_urlsame
Advanced Configurations

BOOSTER_ADV_WS_LEGEND
Customize URL's depending on the features.Legend
Websocket Network Configuration *
BOOSTER_WS_ADVANCED
Use custom URL's for websocket featureGroup_switch:booster_ws_advancedsame
WS Path
WS_PATH
WebSocket pathStringws
Uploader Network Configuration *
BOOSTER_UPLOAD_ADVANCED
Use custom URL's for uploader featureGroup_switch:booster_upload_advancedsame
Upload Server path
UPLOAD_PATH
Upload Server pathStringio
Server Internals
MQ Instanc
UNIQUE_MS_INSTANCE
Choose the plugin, sql should be the default valuePlugin_instance:mqmq.sql
Queue notifications
USE_QUEUE
Post the notification in a temporary queue. You must set up the scheduler accordingly to make sure the queue is then consumed on a regularly basis.Booleanfalse
Use Workers (experimental)
MQ_USE_WORKERS
Send commands in background to workers waiting to execute themBooleanfalse
Worker Status
MQ_WORKER_STATUS
Try to detect if the worker is respondingMonitor
Start Worker
MQ_WORKER_SWITCH_ON
Switch a worker ONButton
Stop Worker
MQ_WORKER_SWITCH_OFF
Switch a worker OFFButton
Administrative API Key
Generate Key
MQ_LEGEND_ADMIN_KEY
Pydio Booster uses an administrative API key pair to communicate with the server. If you start it manually, use the buttons below to generate or revoke key pairs. If you start using the admin dashboard, you should not need that.Legend
Generate API Key
MQ_GENERATE_ADMIN_KEY
Generate KeyButton
Revoke existing API Key(s)
MQ_REVOKE_ADMIN_KEY
Revoke KeyButton