Getting Started

In your terminal on the machine running docker (SSH or console) cd ~/avadroid/<name>/bot/config, where <name> is the folder named after your AvaDroid. Edit config.json .. nano config.json

Find the section that looks like:

"Corrade": {
    "Address": "corrade",
    "Port": 1883,
    "NPort": 54377,
    "Group": "group",
    "Password": "password",
    "Topic": "topic"
  },

Change “Address”: “corrade” to “Address”: “<IP Number of the Host Docker is on>”
Example: "Address": "192.168.1.10" Note the quotation marks as this is a string variable.

Change “Port”: 1883 to “Port”: <Port Number mapped in compose.yml>
Example: "Port": 17001 the MQTT Port. Note NO quotation marks as this is an Integer variable.

Change “NPort”: 54377 to “NPort”: <Port Number mapped in compose.yml>
Example: "NPort": 19001 the Nucleus Port. Note NO quotation marks as this is an Integer variable.

Change “Group”: “group” to “Group”: “<The group you create in Avatar configuration>”
Example: You created the group The_Mob and invited your AvaDroid Avatar to it so, the change will be "Group": "The_Mob" Note the quotation marks as this is a string variable.

Change “Password”: “password” to “Password”: “<Password you set in Corrade Setup>”
Example: "Password": "MyP@ssW0rd1" if you allocated MyP@ssW0rd1 as your your super secret password. Note the quotation marks as this is a string variable.

Change “Topic”: “topic” to “Topic”: “<The group you create in Avatar configuration>/<Password you set in Corrade Setup>”
Example: as above "Topic": "The_Mob/MyP@ssW0rd1" Note the "/" between group and password. Note the quotation marks as this is a string variable. Note there is no "," at the end of this line.

So, using the example the JSON code after you have edited it:

"Corrade": {
    "Address": "192.168.1.10",
    "Port": 17001,
    "NPort": 19001,
    "Group": "The_Mob",
    "Password": "MyP@ssW0rd1",
    "Topic": "The_Mob/MyP@ssW0rd1"
  },

Now save the config.json file, in nano that is CNTL x, y, <enter>.

Return to the avadroid/<name> directory (folder) by in the terminal entering cd .. (back to bot) then cd .. back to <name>. You should be back in /home/<your user>/avadroid/<name>. Do a pwd command in terminal to confirm if you wish.

In Terminal type docker compose down Wait until all removed
Then docker compose up -d wait until all up
Then docker logs <name>-avadroid where <name> is the name of your AvaDroid.

You should get a return where the important information starts with [MQTT].
Example:

[MQTT] Connected to broker.
[MQTT] Subscribed to: The_Mob/MyP@ssW0rd1/local,message,parcel,lure,dialog,permission,alert,command,
ownersay,collision, The_Mob/MyP@ssW0rd1

Connected to Broker. Confirms the IP address and Port is correct.
Subscribed to: … Confirms the Group and Password is correct and lists the subscriptions.

We are done here, time for a Coffee, next step is to hit the GUI and finish the setup.

First time GUI access.