Realtime | |
New in Tiki25. Use built-in websockets server within Tiki to enable realtime communication features of the app. This is optional. If your server doesn't support this, it's OK. If you have it, supported features will be faster and smoother. For now, it is used for Tiki Manager Package, and will later be added to other Tiki Features. Powered by https://packagist.org/packages/cboden/Ratchet and https://reactphp.org This will require a special server configuration (possibly root access). tiki-check.php will indicate if server is correctly set up. In this documentation, we are going to configure Virtualmin (but any other server can be used), and then we will check if it worked. |
Configuration | |
Requirements | |
We already have a Tiki instance up and running, on Virtualmin, now we need to take into account a few more things: Proxy Settings, Realtime Service, proxy_wstunnel, Realtime feature, and Realtime port in Tiki in order to get Realtime working. 1. Proxy SettingsFirst, let us edit Apache directives and add the ProxyPass and the ProxyPassReverse settings in the SSl virtual host. We make both point to /ws ws://localhost:8080/
|
2. Realtime Service | |
At this step, we need to create a Systemd service to start the WS server.
3. The proxy_wstunnelThe last step here in Virtualmin is to make sure the proxy_wstunnel module is enabled.
4. Realtime featureAt this step, we need to enable Realtime feature in Tiki. When not enabled, this feature is visible only upon search.
5. The Realtime portLet's note that this not required, but it is an interesting preference and usefull in some cases (default port is not available), because it allows you to set the port on which the server will be listening to. 8080 is the port number by default...
|
Check that Realtime is working | |
This task is as simple as opening our Tiki and running "Server Check"
|
For developers | |
|
Related links | |