Install and Get Started With Panhandler

Printer Friendly Page

Skillet DistrictSkillet District

 

Panhandler is an open-source application that allows you to import and playback any skillet using a web interface.

 

Complete documentation for Panhandler can be found at https://panhandler.readthedocs.io.

 

Below is a quick summary for installation, importing skillets, playing skillets, and setting the user environment.

 

 

Installation Prerequisites

Panhandler runs inside a docker container so the installation platform must support a docker environment. It is also a simple web server so an open port will be used on the installed platform.

 

NOTE: Panhandler has been tested with Mac and Linux but has not been fully tested or supported with Windows.

 

Installation

Panhandler is installed using the following curl command to pull down and run the docker container. It can also be used to check for and install updates.

 

curl -s -k -L http://bit.ly/2xui5gM | bash

 

Welcome to Panhandler Curl ViewWelcome to Panhandler Curl View

 

Here is what you should see after a few minutes of download, installation, and running the container.

 

Panhandler ContainerPanhandler Container

 

The last line in the output message shows the url including the assigned port for Panhandler access. This example shows port 9999 while other ports such as 8080 may be used. Also note that users can use the server IP address instead of localhost for remote access.

 

Logging into Panhandler

Panhandler requires simple login to the web interface.

Panhandler uses a default username/password: paloalto/panhandler.

 

Panhandler Login ViewPanhandler Login View

 

Panhandler Menus

The pulldown menu in the upper left of the screen allows the user to perform a variety of tasks.

 

  • Welcome: Bottom center of the screen will show the current build version and if updates are available
  • Import Skillets: Quick name and import skillets from GitHub repositories
  • Skillet Collections: View and run currently loaded skillets by category, collection name, or search
  • Skillet Repositories: Manage skillet repositories including pulling updates and switching between branches

 

Panhandler MenuPanhandler Menu

 

Import a Skillet Repository

The import menu leads you to a list of recommended skillets or the ability to import ad hoc skillets.

 

Panhandler Recommended RepositoriesPanhandler Recommended Repositories

 

Import will checkout the master branch. However, some branches may use software versioned branches. Switching is done in the Skillet Repository page.

 

NOTE: When importing be sure to use the clone url ending in .git and not the website url.

 

Once imported, you can immediately run a skillet using links from the bottom of the page or click into a named Collection.

 

Run a Skillet with Skillet Collections

Once in the Skillet Collection page, choose the collection containing the skillet you wish to run. You can also select All Skillets and search by skillet name.

 

Panhandler Skillet CollectionsPanhandler Skillet Collections

 

Inside the Collection, you'll see a list of Skillets. These can be filtered by task, type, or quick find with search.

 

Panhandler Collections for IronSkilletPanhandler Collections for IronSkillet

 

Click Go to run a skillet.

 

NOTE: Some skillets are classified as "workflow," which runs a series of skillets instead of a single task.

 

Manage Skillet Repositories

The Skillet Repository page will show all of the imported skillet repositories.

 

Panhandler Repository Detail for Home SkilletsPanhandler Repository Detail for Home Skillets

 

Inside the repository detail, you can Update to Latest to pull the latest skillet changes or Remove Repository to delete unused repos.

 

If you need to switch to another version/branch, click on the branch name, which takes you to the bottom of the page for branch selection.

 

Panhandler Checkout New Branch for Home SkilletsPanhandler Checkout New Branch for Home Skillets

 

You may still have to Update to Latest after the checkout of a new branch.

 

Configuring the User Environment (Optional)

Skillets are design to prompt the user for username, password, and device address when API calls are required. If multiple devices are periodically used or you wish to bypass the password entry each time, you can create and customize user environments naming and setting attributes for each device.

 

Choose Environments from the upper right pulldown menu.

 

Panhandler Menu on Right SidePanhandler Menu on Right Side

This data is stored encrypted on the user's local disk. You are prompted for an admin password on the first time that is used to access environments in the future.

 

Environment attributes most common used are TARGET_IP, TARGET_USERNAME, and TARGET_PORT to see api call targets.

 

For more details using environments see: https://panhandler.readthedocs.io/en/master/environments.html

Ask Questions Get Answers Join the Live Community
Version history
Revision #:
6 of 6
Last update:
‎02-07-2020 11:15 AM
Updated by:
 
Contributors