PW-KVExplorer 1.0.0

A Web interface using Pode.Web implementing the KV-Explorer feature from the PSKeyBase module and the psConsole script.

This Web interface should be functional on any platform supporting PowerShell core.

See KV-Explorer in action from the CLI.

See PW-KVExplorer in action from the WEB.



Requirements

  1. Install Pode and Pode.Web modules
Install-Module Pode -scope currentuser Install-Module Pode.Web -scope currentuser
  1. Install KeyBase Client

    See KeyBase Client.

  2. Install PSKeyBase module and psConsole.ps1 script

    See PSKeyBase

    See psConsole

  3. Linux Usage

For Linux, gpaste must be installed. sudo apt install xclip xsel sudo apt install gpaste https://fostips.com/find-copy-paste-history-gnome/

Configuration Setup

In the PSKeyBase module location there is a folder named, podeweb that has the following structure.

Mode LastWriteTime Length Name ---- ------------- ------ ---- d---- 5/9/2022 5:23 AM data d---- 5/8/2022 9:34 AM images d---- 5/8/2022 8:59 AM pages -a--- 5/9/2022 5:04 AM 20636 pw-kvexplorer.ps1

The web configuration file, PW-KVExplorer.xml is located in the data folder and has the following structure.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <KVExplorer> <Debug>0</Debug> <KeyBaseLogin> <kventry>Enter-Your-KVKey</kventry> <kvteam></kvteam> <kvnamespace>Enter-NameSpace-for-KVKey</kvnamespace> </KeyBaseLogin> <PodeWebCfg> <title>KVExplorer</title> <address>localhost</address> <port>23001</port> <protocol>http</protocol> <authenticate>0</authenticate> <duration>60</duration> <logo>/pode.web/images/keybase-icon.jpg</logo> <logo1>/pode.web/images/DeatonCoatOfArms-1.jpg</logo1> <background>/pode.web/images/Bow-Lightening.png</background> </PodeWebCfg> </KVExplorer>

At a minimum, the kventry and kvnamespace values will need to be modified to match your Keybase configuration.

Also note, that web authentication has been disabled by setting authenticate to 0. Setting it to '1' will enable authentication.

The podeweb folder can be relocated to any directory path on your computer if desired.


Running the Web Server

Before running the Web Server, the CLI interface for cmdlets in the PSKeyBase module should be functional and the psConsole script should be functional as well.

Set your current working directory to the location of the PW-KVExplorer.ps1 folder. PS1> ./pw-kvexplorer.ps1

Version History

Version Date Description
1.0.0 2022-05-11 Initial implementation