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

Revised README.md files to take Rudefox repo into account

Browse Source
This commit is contained in:
B.J. Dweck 2020-10-20 12:26:26 +02:00
parent 59ddc37cfd
commit 26d4444137
2 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -13,7 +13,19 @@ A TORch solution consists of 3 processes:
* MQTT broker - Any MQTT broker, reachable via IPv4 or Tor, through TLS or insecure communications * MQTT broker - Any MQTT broker, reachable via IPv4 or Tor, through TLS or insecure communications
* `torch-subscriber` - Listens for and handles onion hostname publications * `torch-subscriber` - Listens for and handles onion hostname publications
## Build Debian Package ## Installation
### Install Package from Rudefox Debian Repo
1. Add the [Rudefox Repo](https://rudefox.io/repo/) as an `apt` source
2. Install the `torch-agent` package
```bash
sudo apt install torch-agent
```
### Build Debian Package from Source
If you don't already have a GPG key, generate one: If you don't already have a GPG key, generate one:
@ -44,4 +56,4 @@ The configuation directory can be specified by
A fully configured example can be found [here](example) A fully configured example can be found [here](example)
See the sample [`torch.conf`](torch.conf) file for additional configuration options and details See the sample [`torch.conf`](torch.conf) file for additional configuration options and details

11
example/README.md
View File

@ -35,19 +35,10 @@ In a separate terminal window, run the subscriber:
#### Run TORch Agent in Vagrant #### Run TORch Agent in Vagrant
[Build](..) the latest source into a Debian package and copy it to `example/`
```bash
cd ..
./make-pkg.sh john@doe.com
cp -f build/torch-agent_0.0.5-1_all.deb example/
cd example
```
Run the Vagrant box in a third terminal window: Run the Vagrant box in a third terminal window:
```bash ```bash
vagrant up vagrant up
``` ```
You should see that the broker received a connection from the Vagrant box at boot up and the subscriber received the onion hostname. You can use a local `tor` proxy to connect to the vagrant box using SSH and the onion hostname. You should see that the broker received a connection from the Vagrant box at boot up and the subscriber received the onion hostname. You can use a local `tor` proxy to connect to the vagrant box using SSH and the onion hostname.