https://github.com/snare/idiot

Your best is an idiot
https://github.com/snare/idiot

Last synced: about 1 month ago
JSON representation

Your best is an idiot

• Host: GitHub
• URL: https://github.com/snare/idiot
• Owner: snare
• License: mit
• Created: 2016-03-16T07:30:10.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-04-14T03:08:43.000Z (over 8 years ago)
• Last Synced: 2024-07-29T05:28:55.874Z (about 2 months ago)
• Language: Python
• Size: 46.9 KB
• Stars: 138
• Watchers: 7
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• Mac-Menubar-Megalist - Idiot

README

        
# idiot

*Your best is an idiot.*

Idiot is an OS X tool for reminding you not to be stupid.

* Ever turn off your firewall because that Meterpreter callback wasn't working and then forget to turn it back on?

* Ever run Apache to test something and forget to kill it?

* Ever spin up a MongoDB instance in Docker and accidentally leave it running with no password and a ton of production data in it?

Idiot is the tool for you. Idiot runs checks (written in Python) every now and then, and if it finds something is awry it will throw up a notification dialog and put an indicative icon in the OS X status bar. It will keep reminding you every time it checks, until you either "snooze" notifications for that particular check or defenestrate your machine.

Built-in checks:

* Apache

* Firewall

* Docker

* Vagrant

* ARDAgent

* File sharing

* Screen sharing

* SSH

* File watcher

* Directory size warnings

## Installation

Download the latest binary [here](https://github.com/snare/idiot/releases), unzip the zip file and drag the app to the `/Applications` folder.

Or clone this repo and install the Python package if you want to run it from the command line:

    $ python setup.py install

## Building

To build the app:

    $ python setup.py py2app

## Running

Launch `Idiot.app`.

Alternatively, you can run Idiot from the command line. The only caveat is that you will get a Python icon in the dock.

    $ python setup.py install

    $ idiot

### Status Menu

Idiot adds an icon to the OS X status bar. Hopefully this will be a happy face telling you everything is OK. If something goes wrong, the icon changes. The menu underneath the icon reflects the status of the most recent run of checks:

![status_menu](http://i.imgur.com/su5qjfN.png)

### Notifications

Whenever a check is failed, a notification is displayed via OS X's Notification Center. Notifications have 2 buttons: "Dismiss" and "Snooze". "Dismiss" simply closes the notification. "Snooze", however, notifies Idiot that you'd like to temporarily disable notifications for this particular check.

![notification](http://i.imgur.com/YzlteKX.png)

Snoozing uses a series of intervals (by default 1hr, 6hrs and forever) so the first time you snooze for a check it will disable notifications for the first interval (e.g. 1hr). If you hit snooze again it'll disable for the second interval (e.g. 6hrs), and if you hit snooze a third time it will disable for the 3rd interval (e.g. forever by default). "Forever" in this instance means "until the check is passed again" (so, until the firewall is enabled and Idiot checks it again, for example). Snooze state does not persist across restarts of Idiot.

## Configuration

Create a file at `~/.idiot/config` to customise configuration. See `config/default.conf` in the package for more info. You can probably guess.

## Extending

See `checks/*` in the `idiot` package for examples.

User-defined checks are placed in `~/.idiot/checks`.

New checks must be explicitly enabled in config. Edit your `~/.idiot/config` and copy in the list of enabled checks from `config/default.conf`, then add your user check's class name to the list:

    enabled:

      - ApacheCheck

      ...

      - MyUserCheck

When testing, you might want to edit your config to enable debug logging, make the checks run more frequently and lower the snooze intervals with a config like this:

    debug_logging:  true

    check_interval: 10

    snooze_intervals: [60, 120, 'forever']

## FAQ

If you get the following error:

    : notification() got an unexpected keyword argument 'actionButton'

then you probably don't have [snare's fork](https://github.com/snare/rumps) of `rumps` installed. It should be installed automatically by the `setup.py`, but if you already had a version `rumps` installed it may not have been. A PR to integrate the improvements to `rumps` used in Idiot has been issued but not merged yet.

## License

See LICENSE file.