diff --git a/README.md b/README.md index 334bf1a..93c97fa 100644 --- a/README.md +++ b/README.md @@ -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 * `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: @@ -44,4 +56,4 @@ The configuation directory can be specified by A fully configured example can be found [here](example) -See the sample [`torch.conf`](torch.conf) file for additional configuration options and details \ No newline at end of file +See the sample [`torch.conf`](torch.conf) file for additional configuration options and details diff --git a/example/README.md b/example/README.md index 4325c1f..3116ab3 100755 --- a/example/README.md +++ b/example/README.md @@ -35,19 +35,10 @@ In a separate terminal window, run the subscriber: #### 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: ```bash 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. \ No newline at end of file +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.