search

johnholbrook / streamdeck-pihole

Streamdeck plugin for monitoring & controlling Pi-hole
https://apps.elgato.com/plugins/us.johnholbrook.pihole
32 stars 5 forks source link

Instructions on Using? #1

Closed texaszman closed 2 years ago

texaszman commented 2 years ago

Hi John - I use PiHole a lot and toggle it off and on for development and work. However I cannot seem to get my StreamDeck to work with your plug in. Is there a readme or instruction set somewhere? Thanks in advance!

johnholbrook commented 2 years ago

I don't have setup instructions written at the moment – that would be a good thing to have.

But all you should have to do is add a "toggle" or "temporarily disable" action, and in the settings area that appears, paste in your pi-hole API key. The key can be found in the Pi-hole web interface at Settings > API/Web Interface > Show API Token > Yes, Show API Token. This will then load a page with a QR code and the token below it – just copy the token and paste it into the action's settings.

If you're using the "temporarily disable" action, you'll also need to specify the amount of time to disable pi-hole for when the action is triggered.

The "Address" field can probably be left blank – you only need to specify the address if the pi-hole install you're targeting cannot be reached at pi.hole – this is not the case for the majority of situations.

Lastly, under "display info" you can choose a stat to display on the action, or leave it on "none" to not display any stats.

Hope that helped! Let me know if your'e still having trouble using the plugin.

texaszman commented 2 years ago

Thanks John – Got it going – worked perfectly and a great utility with SteamDeck!

Appreciate your help1

Don Z

From: John Holbrook @.> Sent: Monday, October 25, 2021 2:50 PM To: johnholbrook/streamdeck-pihole @.> Cc: Don Z @.>; Author @.> Subject: Re: [johnholbrook/streamdeck-pihole] Instructions on Using? (Issue #1)

I don't have setup instructions written at the moment – that would be a good thing to have.

But all you should have to do is add a "toggle" or "temporarily disable" action, and in the settings area that appears, paste in your pi-hole API key. The key can be found in the Pi-hole web interface at Settings > API/Web Interface > Show API Token > Yes, Show API Token. This will then load a page with a QR code and the token below it – just copy the token and paste it into the action's settings.

If you're using the "temporarily disable" action, you'll also need to specify the amount of time to disable pi-hole for when the action is triggered.

The "Address" field can probably be left blank – you only need to specify the address if the pi-hole install you're targeting cannot be reached at pi.hole – this is not the case for the majority of situations.

Lastly, under "display info" you can choose a stat to display on the action, or leave it on "none" to not display any stats.

Hope that helped! Let me know if your'e still having trouble using the plugin.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/johnholbrook/streamdeck-pihole/issues/1#issuecomment-951254270 , or unsubscribe https://github.com/notifications/unsubscribe-auth/AB55NRSPI6T4W3MSLURVKTDUIWYGXANCNFSM5GSRRWNA . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub . https://github.com/notifications/beacon/AB55NRX64ZSQ6V7RYXDT7O3UIWYGXA5CNFSM5GSRRWNKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOHCZPZ7Q.gif