From cf0e964c180aad7c81ab70224e399cd0bd681bad Mon Sep 17 00:00:00 2001 From: chz160 Date: Tue, 16 Apr 2024 20:57:36 -0500 Subject: [PATCH] Updated README.md to account for default custom plugin directory as well as adjusted the documented home-network config to match the code. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ab844af..7eafc65 100644 --- a/README.md +++ b/README.md @@ -14,18 +14,18 @@ apt update; apt install nmap macchanger ## Install and Configure Plugin -1. While SSH'd in to the Pwnagotchi, create a new folder for third-party Pwnagotchi plugins: `mkdir /root/custom_plugins/` +1. While SSH'd in to the Pwnagotchi, create a new folder for third-party Pwnagotchi plugins: `mkdir /root/custom_plugins/` or use the default custom plugin directory of `/usr/local/share/pwnagotchi/custom-plugins/` 1. Grab the `educational-purposes-only.py` file from this Github repo and put it into that custom plugins directory. -1. Edit `/etc/pwnagotchi/config.toml` and change the `main.custom_plugins` variable to point to the custom plugins directory you just created: `main.custom_plugins = "/root/custom_plugins/"` +1. If you are not using the default location for custom plugins, edit `/etc/pwnagotchi/config.toml` and change the `main.custom_plugins` variable to point to the custom plugins directory you just created: `main.custom_plugins = "/root/custom_plugins"` 1. In the same `/etc/pwnagotchi/config.toml` file, add the following lines to enable and configure the plugin: ``` main.plugins.educational-purposes-only.enabled = true -main.plugins.educational-purposes-only.home_network = "Home Network SSID" +main.plugins.educational-purposes-only.home-network = "Home Network SSID" main.plugins.educational-purposes-only.home-password = "Home Network Password" # FIXME: use consistent hyphen or underscores in variable names main.plugins.educational-purposes-only.minimum-signal-strength = -75 # Minimum accepted RSSI (should be a negative integer)