XMR PHAR File path

Get Help CMS Installation
1

CMS Version

4.2.1

Installation Method

Manual Installation

Operating System

Rocky Linux 9.5

Issue

I have installed Xibo CMS 4.2.1 and now I want to install XMR on the same Server. I left the PHAR file as it is in /var/www/xibo/vendor/bin/xmr.phar and created a config.json in the same directory with the following content (IP Adress Replaced):

{
“sockets”: {
“ws”: “192.168.1.1:8080”,
“api”: “192.168.1.1:8081”,
“zmq”: [“tcp://192.168.1.1:9505”]
},
“debug”: true
}

But when I want to run the PHAR File, I get following Error

[root@HOSTNAME_REPLACED xibo]# php /var/www/xibo/vendor/bin/xmr.phar
PHP Fatal error: Uncaught InvalidArgumentException: Missing /var/www/xibo/vendor/xibosignage/xibo-xmr/bin/config.json file, please create one in /var/www/xibo/vendor/xibosignage/xibo-xmr/bin in phar:///var/www/xibo/vendor/xibosignage/xibo-xmr/bin/xmr.phar/index.php:46
Stack trace:
#0 /var/www/xibo/vendor/xibosignage/xibo-xmr/bin/xmr.phar(14): require()
#1 /var/www/xibo/vendor/bin/xmr.phar(119): include(‘…’)
#2 {main}
thrown in phar:///var/www/xibo/vendor/xibosignage/xibo-xmr/bin/xmr.phar/index.php on line 46

But the Xibo Docs say, that the config.json has to be in the same directory. What is true now?

Additionally, I am confused by this Github Issue, do I have to replace my PHAR file or not? XMR: the PHAR file with 1.0 release is an older version · Issue #3604 · xibosignage/xibo · GitHub

2

I have the exact same issue and need urgent help

1 Like
3

Distributing the PHAR file inside the CMS was a mistake which has been corrected in 4.2.1; we will update the documentation.

As you are installing manually, you should get your XMR release from the XMR releases page: Releases · xibosignage/xibo-xmr · GitHub. You can either take the container or the PHAR file, its up to you.

The config.json file should be in the same directory as your PHAR file.

4

Thanks for your answer!

Yes please update the docs, since I have an upcoming school project and a requirement is to install Xibo according to the documentation. I am not allowed to use docker.

My current status is: I have replaced the /var/www/xibo/vendor/bin/xmr.phar with the xmr.phar from the Github Release (Version 1.0). I have placed the config.json (same content as mentioned above) in the same directory as the xmr.phar (you have said under “Websockets configuration in 4.2” that you’d recommend another directory but I did it before your answer and since you said it is totally possible in the same directory, this shouldn’t change anything for my issue now.) Now when I run “php xmr.phar”, it seems to work, I get the following:

[root@HOSTNAME_REPLACED bin]# php xmr.phar
[2025-03-24 12:14:51] xmr.INFO: HTTP listening
[2025-03-24 12:14:51] xmr.INFO: WS listening on 192.168.1.1:8080
[2025-03-24 12:14:51] xmr.INFO: Legacy: handling old messages
[2025-03-24 12:14:51] xmr.INFO: Bind to tcp://192.168.1.1:9505 for Publish.
[2025-03-24 12:14:51] xmr.DEBUG: Adding a queue processor for every 5 seconds
[2025-03-24 12:15:21] xmr.DEBUG: Heartbeat…

In my Xibo Web interface, I have the follwowing settings:

XMR Private Address: http://192.168.1.1:8081
XMR WebSocket Address: ws://192.168.1.1:8080
XMR Public Address: tcp://192.168.1.1:9505

I have installed the newest Windows Player on a notebook and authorised it. I also made sure to deactivate “Force HTTPS” in the Windows Display Profile since I haven’t configured https yet.

But XMR still doesn’t seem to work. When request a screenshot, it doesn’t show up quickly like it should. When I click i on the player, I see the follwoing:

XMR Status: Connected (tcp://192.168.1.1:9505), Waiting for messages

So it isn’t even connected to WS (but you said in the other post that WS isn’t even working yet? didn’t quite get it there what the current status is)

When I request a Screenshot, I instantly see in the player that it changes from:

Connected (tcp://192.168.1.1:9505), Waiting for messages

to

Connected (tcp://192.168.1.1:9505), last activity: date and time

So the communication somehow works but still doesn’t because I don’t get a screenshot.

I have tested the following on the Windows Player via Powershell and it is successful, so no network or firewall problems there:

Test-NetConnection 192.168.1.1 -Port 8080

What am I doing wrong?

5

@dan Hi, do you have any response on this? How do I manage to run XMR on a manual Installation, even if it is via ZeroMQ?

6

Hey Mohamed
I’ve managed to run XMR (Websockets). I’m using this phar: Releases · xibosignage/xibo-xmr · GitHub and replaced the one in /vendor/bin/xmr.phar

Greetings

1 Like
7

The following steps is what helped me make XMR work on an Ubuntu Server using Apache2, with Xibo 4.2.2

Hopefully this guide will help other people get XMR running in their own enveiroment as well.

Xibo settings

Under settings > Display
Make sure to replace … with the actual IP-address of your server.

  • XMR Private: http://…:8080
  • XMR Websocket: http://…:8081
  • XMR Pubic: tcp://…:9505

config.json

Make sure you have config.json inside <xibo_installation_dir>/vendor/bin configured with the following:

{
    "sockets": {
        "ws": "0.0.0.0:8080",
        "api": "0.0.0.0:8081",
        "zmq": ["tcp://*:9505"]
       },
    "debug": false
}

Update xmr.phar

Download version 1.0 of xmr.phar from Releases · xibosignage/xibo-xmr · GitHub
Replace this file in <xibo_installation_dir>/vendor/bin.

Enable legacy support for OpenSSL

Open the OpenSSL config:
sudo nano /etc/ssl/openssl.cnf

Proceed to add the following lines at the bottom:

# Enable legacy support
[openssl_init]
providers = provider_sect
ssl_conf = ssl_sect

[ssl_sect]
system_default = system_default_sect

[system_default_sect]
MinProtocol = TLSv1.2
CipherString = DEFAULT@SECLEVEL=1

[provider_sect]
default = default_sect
legacy = legacy_sect

[default_sect]
activate = 1

[legacy_sect]
activate = 1

Exit and restart OpenSSL

sudo systemctl restart openssl

Configure a ServerName for Apache2

I also added the ServerName to my apache2 config.

sudo nano /etc/apache2/apache2.conf

Add the following line: (Modify the name to match your environment)

ServerName cms.domain.com

Exit and restart apache

systemctl restart apache2

Firewall

Make sure port 9505, 8081 and 8080 are open.

Checking functionality

It has helped out a lot to set the Server Mode under Settings > Troubleshooting to “Test”.
After that I proceeded to send a command trough the API to one of my Xibo Players. This made it easier identifying the problem compared to sending a command trough your webbrowser. It should not give an error when you send a command to a player.