Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated in accordance to new TOML format used in config #24

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open
44 changes: 21 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,32 @@
These are user contributed plugins for [pwnagotchi](https://github.com/evilsocket/pwnagotchi), some of them have not been
completely tested by the dev team, **use them at your own risk**.

In order to use these plugins, clone the repository anywhere on your unit and then add its path to `/etc/pwnagotchi/config.yml` as:
In order to use these plugins, clone the repository anywhere on your unit and then add its path to `/etc/pwnagotchi/config.toml` as:

```yaml
main:
custom_plugins: "/path/to/this/folder"
```toml
main.custom_plugins = "/path/to/this/folder"
```

Each plugin has its own configuration than must be part of the `main.plugins` section. If for instance you want to enable
the auto_backup plugin, you need to edit your config.yml and add this:
the auto_backup plugin, you need to edit your config.toml and add this:

```yaml
main:
custom_plugins: "/path/to/this/folder"
plugins:
auto_backup:
enabled: true
interval: 1 # every day
max_tries: 0 # 0=infinity
files:
- /root/brain.nn
- /root/brain.json
- /root/.api-report.json
- /root/handshakes/
- /root/peers/
- /etc/pwnagotchi/
- /var/log/pwnagotchi.log
commands:
- 'tar czf /root/pwnagotchi-backup.tar.gz {files}'
```toml
main.custom_plugins = "path/to/this/folder"
main.plugins.auto_backup.enabled = true
main.plugins.auto_backup.interval = 1 # every day
main.plugins.auto_backup.max_tries = 0 # 0=infinity
main.plugins.auto_backup.files = [
"/root/brain.nn",
"root/brain.json",
"/root/.api-report.json",
"/root/handshakes/",
"/root/peers/",
"/etc/pwnagotchi/",
"var/log/pwnagotchi.log"
]
main.plugins.auto_backup.commands = [
"tar czf /root/pwnagotchi-backup.tar.gz {files}"
]
```

## License
Expand Down
2 changes: 2 additions & 0 deletions aircrackonly.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
main.plugins.aircrackonly.enabled = true
main.plugins.aircrackonly.face = "(>.<)"
3 changes: 0 additions & 3 deletions aircrackonly.yml

This file was deleted.

15 changes: 15 additions & 0 deletions auto_backup.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
main.plugins.auto_backup.enabled = true
main.plugins.auto_backup.interval = 1 # every day
main.plugins.auto_backup.max_tries = 0 # 0=infinity
main.plugins.auto_backup.files = [
"/root/brain.nn",
"root/brain.json",
"/root/.api-report.json",
"/root/handshakes/",
"/root/peers/",
"/etc/pwnagotchi/",
"var/log/pwnagotchi.log"
]
main.plugins.auto_backup.commands = [
"tar czf /root/pwnagotchi-backup.tar.gz {files}"
]
14 changes: 0 additions & 14 deletions auto_backup.yml

This file was deleted.

46 changes: 46 additions & 0 deletions buttonshim.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
main.plugins.buttonshim.enabled = false

main.plugins.buttonshim.buttons.A.command = ""
main.plugins.buttonshim.buttons.A.blink.enabled = false
main.plugins.buttonshim.buttons.A.blink.red = 0
main.plugins.buttonshim.buttons.A.blink.green = 0
main.plugins.buttonshim.buttons.A.blink.blue = 0
main.plugins.buttonshim.buttons.A.blink.on_time = 0
main.plugins.buttonshim.buttons.A.blink.off_time = 0
main.plugins.buttonshim.buttons.A.blink.blink_times = 0

main.plugins.buttonshim.buttons.B.command = ""
main.plugins.buttonshim.buttons.B.blink.enabled = false
main.plugins.buttonshim.buttons.B.blink.red = 0
main.plugins.buttonshim.buttons.B.blink.green = 0
main.plugins.buttonshim.buttons.B.blink.blue = 0
main.plugins.buttonshim.buttons.B.blink.on_time = 0
main.plugins.buttonshim.buttons.B.blink.off_time = 0
main.plugins.buttonshim.buttons.B.blink.blink_times = 0

main.plugins.buttonshim.buttons.C.command = ""
main.plugins.buttonshim.buttons.C.blink.enabled = false
main.plugins.buttonshim.buttons.C.blink.red = 0
main.plugins.buttonshim.buttons.C.blink.green = 0
main.plugins.buttonshim.buttons.C.blink.blue = 0
main.plugins.buttonshim.buttons.C.blink.on_time = 0
main.plugins.buttonshim.buttons.C.blink.off_time = 0
main.plugins.buttonshim.buttons.C.blink.blink_times = 0

main.plugins.buttonshim.buttons.D.command = ""
main.plugins.buttonshim.buttons.D.blink.enabled = false
main.plugins.buttonshim.buttons.D.blink.red = 0
main.plugins.buttonshim.buttons.D.blink.green = 0
main.plugins.buttonshim.buttons.D.blink.blue = 0
main.plugins.buttonshim.buttons.D.blink.on_time = 0
main.plugins.buttonshim.buttons.D.blink.off_time = 0
main.plugins.buttonshim.buttons.D.blink.blink_times = 0

main.plugins.buttonshim.buttons.E.command = ""
main.plugins.buttonshim.buttons.E.blink.enabled = false
main.plugins.buttonshim.buttons.E.blink.red = 0
main.plugins.buttonshim.buttons.E.blink.green = 0
main.plugins.buttonshim.buttons.E.blink.blue = 0
main.plugins.buttonshim.buttons.E.blink.on_time = 0
main.plugins.buttonshim.buttons.E.blink.off_time = 0
main.plugins.buttonshim.buttons.E.blink.blink_times = 0
53 changes: 0 additions & 53 deletions buttonshim.yml

This file was deleted.

3 changes: 3 additions & 0 deletions discord.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
main.plugins.discord.enabled = false # requires discord.py module to work (pip3 install discord.py)
main.plugins.discord.webhook_url = ~
main.plugins.discord.username = "pwnagotchi " # defaults to hostname if not set
4 changes: 0 additions & 4 deletions discord.yml

This file was deleted.

2 changes: 2 additions & 0 deletions gpio_shutdown.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
main.plugins.gpio_shutdown.enabled = false
main.plugins.gpio_shutdown.gpio = 21
3 changes: 0 additions & 3 deletions gpio_shutdown.yml

This file was deleted.

1 change: 1 addition & 0 deletions handshakes-dl.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
main.plugins.handshakes-dl.enabled = false
2 changes: 0 additions & 2 deletions handshakes-dl.yml

This file was deleted.

5 changes: 5 additions & 0 deletions mastodon.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
main.plugins.mastodon.enabled = false
main.plugins.mastodon.instance_url = ""
main.plugins.mastodon.visibility= "unlisted"
main.plugins.mastodon.email = ""
main.plugins.mastodon.password = ""
6 changes: 0 additions & 6 deletions mastodon.yml

This file was deleted.

3 changes: 3 additions & 0 deletions quickdic.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
main.plugins.quickdic.enabled = false
main.plugins.quickdic.wordlist_folder = "/opt/wordlists/"
main.plugins.quickdic.face = "(·ω·)"
4 changes: 0 additions & 4 deletions quickdic.yml

This file was deleted.

2 changes: 2 additions & 0 deletions screen_refresh.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
main.plugins.screen_refresh.enabled = false
main.plugins.screen_refresh.refresh_interval = 50
3 changes: 0 additions & 3 deletions screen_refresh.yml

This file was deleted.

6 changes: 6 additions & 0 deletions telegram.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
main.plugins.telegram.enabled = false
main.plugins.telegram.bot_token = ~
main.plugins.telegram.bot_name = "pwnagotchi"
main.plugins.telegram.chat_id = ~
main.plugins.telegram.send_picture = true
main.plugins.telegram.send_message = true
7 changes: 0 additions & 7 deletions telegram.yml

This file was deleted.

5 changes: 5 additions & 0 deletions twitter.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
main.plugins.twitter.enabled = false
main.plugins.twitter.consumer_key = ""
main.plugins.twitter.consumer_secret = ""
main.plugins.twitter.access_token_key = ""
main.plugins.twitter.access_token_secret = ""
6 changes: 0 additions & 6 deletions twitter.yml

This file was deleted.