FauxAPI-1.3_3 release

package/LATEST

@@ -1 +1 @@
-pfSense-pkg-FauxAPI-1.3_2.txz
+pfSense-pkg-FauxAPI-1.3_3.txz

package/README.md

@@ -9,12 +9,12 @@ installation example below.  It takes just 2x commands to install and just 1x
 command to de-install if you need to.
 
 ## Current Version
- - pfSense-pkg-FauxAPI-1.3_1.txz
- - SHA256: cc3d1cac94b9088b13330f72dfbad8a080ca853cd292ad3bbecb5fc6a8497e62
+ - pfSense-pkg-FauxAPI-1.3_3.txz
+ - SHA256: 9ed0e5a61a1cb954b203d732c3d0d141dacd4f7b26ed5d892819683f15659f47
 
 ## Installation Example
 ```
-[2.4.3-RELEASE][[email protected]]/root: pkg-static install pfSense-pkg-FauxAPI-1.3_1.txz
+[2.4.3-RELEASE][[email protected]]/root: pkg-static install pfSense-pkg-FauxAPI-1.3_3.txz
 Updating pfSense-core repository catalogue...
 pfSense-core repository is up to date.
 Updating pfSense repository catalogue...
@@ -25,13 +25,13 @@ Checking integrity... done (0 conflicting)
 The following 1 package(s) will be affected (of 0 checked):
 
 New packages to be INSTALLED:
-	pfSense-pkg-FauxAPI: 1.3_1 [unknown-repository]
+	pfSense-pkg-FauxAPI: 1.3_3 [unknown-repository]
 
 Number of packages to be installed: 1
 
 Proceed with this action? [y/N]: y
-[1/1] Installing pfSense-pkg-FauxAPI-1.3_1...
-Extracting pfSense-pkg-FauxAPI-1.3_1: 100%
+[1/1] Installing pfSense-pkg-FauxAPI-1.3_3...
+Extracting pfSense-pkg-FauxAPI-1.3_3: 100%
 Saving updated package information...
 done.
 Loading package configuration... done.
@@ -49,15 +49,15 @@ Checking integrity... done (0 conflicting)
 Deinstallation has been requested for the following 1 packages (of 0 packages in the universe):
 
 Installed packages to be REMOVED:
-	pfSense-pkg-FauxAPI-1.3_1
+	pfSense-pkg-FauxAPI-1.3_3
 
 Number of packages to be removed: 1
 
 Proceed with deinstalling packages? [y/N]: y
-[1/1] Deinstalling pfSense-pkg-FauxAPI-1.3_1...
+[1/1] Deinstalling pfSense-pkg-FauxAPI-1.3_3...
 Removing FauxAPI components...
 Menu items... done.
-[1/1] Deleting files for pfSense-pkg-FauxAPI-1.3_1: 100%
+[1/1] Deleting files for pfSense-pkg-FauxAPI-1.3_3: 100%
 Removing FauxAPI components...
 Configuration... done.
 [2.4.3-RELEASE][[email protected]]/root: 

package/SHA256SUMS

@@ -7,3 +7,4 @@ e06079b5ea7ec0dd32612c324e4dec3aa1720adf573a055b060d4f67344be552  pfSense-pkg-Fa
 aa01bd1750c325584291f7842ae7c0c20d9b82c9b5fa38bd79cce61c2f88031f  pfSense-pkg-FauxAPI-1.2_2.txz
 cc3d1cac94b9088b13330f72dfbad8a080ca853cd292ad3bbecb5fc6a8497e62  pfSense-pkg-FauxAPI-1.3_1.txz
 a1770eebae1acc38c2c28fc227bc64561f4e80b01cc3cbffe3655d02c84673ef  pfSense-pkg-FauxAPI-1.3_2.txz
+9ed0e5a61a1cb954b203d732c3d0d141dacd4f7b26ed5d892819683f15659f47  pfSense-pkg-FauxAPI-1.3_3.txz

pfSense-pkg-FauxAPI/Makefile

@@ -2,7 +2,7 @@
 
 PORTNAME=	pfSense-pkg-FauxAPI
 PORTVERSION=	1.3
-PORTREVISION=	2
+PORTREVISION=	3
 CATEGORIES=	sysutils
 MASTER_SITES=	# empty
 DISTFILES=	# empty

pfSense-pkg-FauxAPI/files/usr/local/www/fauxapi/admin/about.php

@@ -127,6 +127,8 @@
 <p>Refer to the published package <a href="https://github.com/ndejong/pfsense_fauxapi/blob/master/package/SHA256SUMS"><code>SHA256SUMS</code></a></p>
 <p><strong>Hint:</strong> if not already, consider installing the <code>jq</code> tool on your local machine (not
 pfSense host) to pipe and manage JSON outputs from FauxAPI - <a href="https://stedolan.github.io/jq/" rel="nofollow">https://stedolan.github.io/jq/</a></p>
+<p><strong>NB:</strong> you MUST at least setup your <code>/etc/fauxapi/credentials.ini</code> file on the
+pfSense host before you continue, see the API Authentication section below.</p>
 <h2>
 <a id="user-content-client-libraries" class="anchor" href="#client-libraries" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Client libraries</h2>
 <h4>
@@ -186,9 +188,11 @@
 FauxAPI <code>/etc/fauxapi/credentials.ini</code> file - happy to receive feedback about
 this approach.</p>
 <p>The two sample FauxAPI keys (PFFAexample01 and PFFAexample02) and their
-associated secrets in the sample <code>credentials.ini</code> file are hard-coded to be
-inoperative, you must create entirely new values before your client scripts
+associated secrets in the sample <code>credentials.sample.ini</code> file are hard-coded to
+be inoperative, you must create entirely new values before your client scripts
 will be able to issue commands to FauxAPI.</p>
+<p>You can start your own <code>/etc/fauxapi/credentials.ini</code> file by copying the sample
+file provided in <code>credentials.sample.ini</code></p>
 <p>API authentication itself is performed on a per-call basis with the auth value
 inserted as an additional <strong>fauxapi-auth</strong> HTTP request header, it can be
 calculated as such:-</p>
@@ -599,6 +603,9 @@ function thus causing all FauxAPI actions to be logged and auditable on a per
 <li>Functions to be called via this interface <em>MUST</em> be defined in the file
 <code>/etc/pfsense_function_calls.txt</code> only a handful very basic and
 read-only pfSense functions are enabled by default.</li>
+<li>You can start your own <code>/etc/fauxapi/pfsense_function_calls.txt</code> file by
+copying the sample file provided in <code>pfsense_function_calls.sample.txt</code>
+</li>
 <li>HTTP: <strong>POST</strong>
 </li>
 <li>Params: none</li>