Skip to content

Commit 5792c25

Browse files
committed
read-me-and-media-streaming
1 parent f1401ef commit 5792c25

File tree

2 files changed

+5
-19
lines changed

2 files changed

+5
-19
lines changed

README.md

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Global Input App WebSocket Server
2-
This is a WebSocket server responsible for relaying encrypted messages between devices.
3-
Because the Mobile Integration Platform, which is powered by [Global Input App](https://globalinput.co.uk/), secures data using end-to-end encryption at the device-to-device level, the WebSocket server can run on an unsecured infrastructure.
2+
This is a WebSocket server that is used by [Global Input App](https://globalinput.co.uk/) and the client applications to communicate with each other. Sine messages are secured using the end-to-end encryption, WebSocket servers can be installed on unsecured environments. Web applications can also use the WebSocket server to implement live streaming using WebRTC. This WebSocket server use the API Key to identify/authenticate incoming requests and is able to distribute them to multiple nodes to manage scalability without any additional service/components.
43

54
### Download
65
Download the application source code:
@@ -12,24 +11,11 @@ Download the application source code:
1211
```
1312

1413
### Modify the Configuration
15-
The configuration file [/app/config/config.json](https://github.com/global-input/global-input-node/blob/master/app/config/config.json) contains the information to inform the devices how to connect to the WebSocket server:
16-
```
17-
....
18-
"name":"default",
19-
"apikey":"k7jc3QcMPKEXGW5UC",
20-
"url":"https://node3.globalinput.co.uk"
21-
...
22-
```
23-
The value of the ```apikey``` parameter is used to control which device applications can use the resource represented by the Web Socket server, and it does not have any data security implication. You can modify the value of the ```url``` parameter to reflect the infrastructure that is set up to run your WebSocket server. The ```url``` should be reachable to both the device application and the mobile app (Global Input App) in order to communicate with each other.
14+
The configuration file [/app/config/config.json](https://github.com/global-input/global-input-node/blob/master/app/config/config.json) contains the API Keys and the addresses of the WebSocket nodes. So it is important to modify it to point to your own WebSocket server(s) before running it(them).
2415

2516
### Run an instance.
2617

2718
```
2819
nodejs server.js
2920
```
30-
Alternative, you can build a docker image using the script provided by this repository or simply download it from the [docker hub](https://cloud.docker.com/u/dilshat/repository/docker/dilshat/global_input_node). You may place a simple [Nginx load balancer](https://cloud.docker.com/repository/docker/dilshat/global_input_nginx) in front of a set of WebSocket instances to achieve the scalability.
31-
32-
33-
34-
35-
21+
Alternative, you can build a docker image or download it from the [docker hub](https://cloud.docker.com/u/dilshat/repository/docker/dilshat/global_input_node).

global_input_node/dockerpush.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
docker tag dilshat/global_input_node dilshat/global_input_node:1.3.0
2-
docker push dilshat/global_input_node:1.3.0
1+
docker tag dilshat/global_input_node dilshat/global_input_node:1.3.1
2+
docker push dilshat/global_input_node:1.3.1

0 commit comments

Comments
 (0)