bj/torch-subscriber-docker
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated README.md

Browse Source
This commit is contained in:
B.J. Dweck 2020-10-23 12:13:00 +02:00
parent e88a341d95
commit 421fc1ffdb
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -20,7 +20,7 @@ It is composed of the following micro-services:
* **BROKER_MQTT_PORT**: (suggested: 1883) must match the port that you configured mosquitto to listen for MQTT on
* **BROKER_MQTTS_PORT**: must match the port that you configured mosquitto to listen for MQTTS on
* **BROKER_MQTTS_PORT**: (suggested: 8883) must match the port that you configured mosquitto to listen for MQTTS on
* **HTTP_PORT**: the port that you would like Torchsub to listen on for incoming HTTP-REST requests for client connection info
@ -43,21 +43,23 @@ It is composed of the following micro-services:
* Keep the onion hostname private
```bash
$ docker-compose exec tor svc-hostname
ubuntu@broker:~$ docker-compose exec tor svc-hostname
*****
* Service Onion Hostname: 24xb3hb2pajid44ugroua2ndvpipvmuw6pfjrivlbupxhpwbugfhdeqd.onion
*****
```
5. Configure any remote [TORch agent](https://git.rudefox.io/bj/torch-agent) instances with the above onion hostname by editing their `torch.conf` files (the idea is really to provision new nodes with this instances of TORch Agent configured with this onion hostname, so that when they boot they will phone home with Tor connection info)
5. Configure any remote [TORch agent](https://git.rudefox.io/bj/torch-agent) instances with the above onion hostname by editing their `torch.conf` files
* Set `BrokerHost` to the Tor onion hostname
* The idea is really to provision new nodes with this instances of TORch Agent configured with this onion hostname, so that when they boot they will phone home with Tor connection info
* Set `BrokerPort` to the Mosquitto MQTT broker port you used above (ex. `1883`)
1. Set `BrokerHost` to the Tor onion hostname
* You should set `RequiredCertificate` to `false` because torch-agent won't be able to match the broker's certificate to the Tor onion hostname
2. Set `BrokerPort` to the Mosquitto MQTT broker port you used above (ex. `1883`)
* Be sure to match the `Topic` with the pattern you told Torchsub to subscribe to when you configured Torchsub using `torch-sub.conf` above
3. You should set `RequiredCertificate` to `false` because torch-agent won't be able to match the broker's certificate to the Tor onion hostname
4. Be sure to match the `Topic` with the pattern you told Torchsub to subscribe to when you configured Torchsub using `torch-sub.conf` above
```bash
# Example TORch Agent torch.conf configuration
@ -82,7 +84,7 @@ KeyFile = vagrant.key
6. Check the latest client connection info using the RESTful interface on the port you specified in the `.env` file above:
```bash
$ curl http://localhost:7700/clients
ubuntu@broker:~$ curl http://localhost:7700/clients
{"vagrant": {"clientId": "vagrant", "timestamp": "23-Oct-2020 (09:35:12.282901)", "onionAddress": "xbkcb3a47s6swrohdzcsuq6iwix3qjsn6mf77dkxywxgxucynhotglyd.onion", "sshPort": 22}}
```