tabulation-ws

Tabulation WebSocket Server

Requirements

• PHP 8.0 or newer (make sure php.exe is in your system PATH)
• Composer
  • The following PHP extensions must be enabled in your php.ini:
    • zip
  • How to enable PHP extensions?

    1. Open your php.ini file in a text editor. (Example location for XAMPP: C:\xampp\php\php.ini)

    2. Search for the following lines and remove the semicolon (;) at the beginning of each to enable them:

       extension=zip
       

    3. Save the php.ini file after making the changes.

---

Development Setup (Port: 8079)

1. Clone the repository.

2. Open the project in a terminal and install the dependencies using Composer:

   composer install
   

3. Start the server in --dev mode:

   php index.php --dev
   

   This runs the WebSocket server on port 8079.

   Notes:

   • Without --dev, it defaults to port 8080. Update your WebSocket URL in the app/config/websocket.php of the tabulation software to use the correct port.
   • You need to run this command again whenever there are updates to the codebase to ensure the latest changes take effect.

---

Production Setup (Port: 8080)

TabulationWS Windows Service

• To run the WebSocket server as a Windows service, follow the installation guide for: service/windows

---

Integration with Tabulation Software

Any Tabulation Software fork that includes a pre-committed app/config/websocket.example.php file is supported. If the file is present in the repository, it means the software is ready to integrate with this WebSocket server.

To connect the Tabulation Software with the WebSocket server:

1. Copy the example config file:

   [tabulation-software]/app/config/websocket.example.php to

   [tabulation-software]/app/config/websocket.php

2. Open the newly created websocket.php and update the WebSocket URL to match the local IP address of the machine where the WebSocket server is running.

   • use port 8079 when running in development mode (--dev)
   • otherwise, use port 8080

3. Open your browser and go to the dashboard using the IP address of the machine where the Tabulation Software is running:

   http://<local-ip>/[tabulation-software]/app/dashboard

   Example:

   http://192.168.0.2/missiriga/app/dashboard