# enable the proxy modules in main apache configuration (if not already done)
LoadModule proxy_module /usr/lib/apache2/modules/mod_proxy.so
LoadModule proxy_wstunnel_module /usr/lib/apache2/modules/mod_proxy_wstunnel.so
LoadModule proxy_http2_module /usr/lib/apache2/modules/mod_proxy_http2.so
LoadModule proxy_http_module /usr/lib/apache2/modules/mod_proxy_http.so 

#
# example configuration of virtual host running translate5
#
<VirtualHost *:80>
    ServerName  example.translate5.net
    DocumentRoot /usr/srv/example.translate5.net/public
    # HTTP access is forbidden by redirecting always to HTTPS
    Redirect permanent / https://example.translate5.net/
</VirtualHost>

<VirtualHost *:443>
    ServerName  example.translate5.net
    DocumentRoot /usr/srv/example.translate5.net/public
    SSLEngine on
    SSLProxyEngine on										# The SSLProxyEngine must be enabled, otherwise you will get errors from apache on reload
    ProxyPass /wss ws://example.translate5.net:9056/        # IMPORTANT: the domain here MUST match the configured domain in the Socket Server configuration in config.php (see below)
</VirtualHost>

<VirtualHost *:443>
    ServerName  anotherexample.translate5.net
    DocumentRoot /usr/srv/anotherexample.translate5.net/public
    SSLEngine on
        # IMPORTANT: Another translate5 installation may use the same socket server, 
        # BUT the socket server may be configured only with one domain!
		# Therefore for anotherexample no separate proxypass is needed because the 
		# GUI must then be configured to use also wss://example.translate5.net!
</VirtualHost>

$configuration = [
    'messageServer' => [
        //address: IP address to listen for connections of translate5 instances 
        // MUST match the server configured in messageServer config in the instance.  
        'address' => '127.0.0.1',
        
        //port:       Port to listen on.
        // MUST match the messagePort config in the instance. 
        'port' => '9057',
    ],
    'socketServer' => [
        //httpHost:   HTTP hostname clients intend to connect to. 
        // IMPORTANT MUST match the socketServer config in the translate5 instance and (if used) in Apache ProxyPass statement!
        //  In environments where an internal and external IP (AWS EC2 for example) is used, the ports must either mapped through, 
        //  or the httpHost should be set here to localhost where the proxypass points to too.
        // (MUST match JS `new WebSocket('ws://$httpHost');`)
        'httpHost' => 'example.translate5.net',
        
        //port:       Port to listen on.
        // MUST match the socketPort config in the instance. 
        'port' => '9056',
        
        //listen:    IP address to bind to. '0.0.0.0' for any interface.
        'listen' => '0.0.0.0',
        
        //route:    The URL path to be used for the socket server, defaults to /translate5 and should normally not to be changed.
        // When using SSL via ProxyPass, the proxy path (/tobedefined/ in the above example) MUST NOT added here!
        'route' => '/translate5', // IMPORTANT although the ProxyPass /wss is used in the example, this MUST NOT added here!
    ]
];

# MUST be set to the socketServer['httpHost'] in above config.php 
# MUST be set to the ProxyPass path target domain in above apache config
# regardless if the translate5 server name is different!
./translate5.sh config runtimeOptions.plugins.FrontEndMessageBus.socketServer.httpHost example.translate5.net

# MUST be set to the ProxyPass alias path in above apache config
./translate5.sh config runtimeOptions.plugins.FrontEndMessageBus.socketServer.schema wss

# MUST be set to your apache SSL port, normally 443
./translate5.sh config runtimeOptions.plugins.FrontEndMessageBus.socketServer.port 443

# MUST match the ProxyPass Alias + the route configured in config.php
./translate5.sh config runtimeOptions.plugins.FrontEndMessageBus.socketServer.route /wss/translate5

./translate5.sh plugin:enable FrontEndMessageBus

# in config.php all default values can be used unchanged, only httpHost must be set to your needs:

        'httpHost' => 'SET.A.VALID.HOSTNAME.HERE',

php server.php

[program:t5socketserver]
command                 = bash -c "exec /usr/bin/php /pathToMessageBus/server.php"
process_name            = Translate5SocketServer
numprocs                = 1
autostart               = true
autorestart             = true
user                    = t5messagebus
stdout_logfile          = /var/log/supervisor/t5-messagebus.log
stdout_logfile_maxbytes = 1MB
stderr_logfile          = /var/log/supervisor/t5-messagebus-error.log
stderr_logfile_maxbytes = 1MB

sudo systemctl restart supervisor

sudo supervisorctl status
# this should output then something similar to:
t5socketserver:Translate5SocketServer   RUNNING   pid 979, uptime 4:37:43

sudo supervisorctl