This is a websocket-based remote display built in NodeJS. It is currently in development, and is generally unusable as of right now.
- Clone the repo with
git clone https://github.com/blewert/remote-display-system
. - Run
npm install
- Alter
config/settings.json
with the relevant details (most importantly, the authentication token) - Alter
carousel.json
to what payloads you wish to send - Run
node server.js
to start the server
Please, please, please change your authentication token in config/settings.json
to something else. The default is just password
, and you will be given if you try run this server with the default value.
You can use your own custom websocket client to connect to the server, or use something like Postman for testing purposes. The remote display system waits for connections, and checks some criteria when a client connects. If all criteria are met, then a successful connection is made to the server. The criteria are as follows:
- When attempting to connect, the client has passed an
authtoken
header. - The passed
authtoken
header matches theauthorisationToken
found inconfig/settings.json
. - When attempting to connect, the client has passed a
displayid
header. - The
displayid
header is parseable as an int withparseInt
. - The
displayid
passed is not already in use by another client.
If all of these are satisfied, a connection is made, otherwise, the client is immediately disconnected.
Version | Date | Notes |
---|---|---|
1.0.0 |
n/a | First initial upload |
1.0.1 |
16/11/21 | Working logger & basis for carousel system |
1.0.2 |
16/11/21 | Added basic authentication |
1.0.3 |
16/11/21 | Adds displayID identification |
1.0.4 |
16/11/21 | Adds some operating modes for carousel system |
1.0.5 |
19/11/21 | Full connection handshake & validation |