2023-05-15 Fred Gleason <[email protected]>

	* Added a usage note to 'apis/cdn/scripts/akamai_purge.cdn'.

Signed-off-by: Fred Gleason <[email protected]>

ChangeLog

@@ -24103,3 +24103,5 @@
 2023-05-15 Fred Gleason <[email protected]>
 	* Remove the seconds field from the 'Air Date/Time' and 'Item Expires'
 	values on the 'Editing Item' dialog in rdcastmanager(1).
+2023-05-15 Fred Gleason <[email protected]>
+	* Added a usage note to 'apis/cdn/scripts/akamai_purge.cdn'.

apis/cdn/scripts/akamai_purge.cdn

@@ -21,6 +21,19 @@
 #   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 #
 
+#
+# Usage: akamai_purge.cdn <target-url>
+#
+# N.B. - For this to work, you must provision an Akamai EdgeGrid access
+#        token with read/write access to Akamai's CCU APIs and place it
+#        at '/usr/share/rivendell/keys/edgegrid.conf'. The token file should
+#        be owned by the 'rivendell' user and group and have permission bits
+#        set to 0600.
+#
+#        For additional information, see:
+#          https://techdocs.akamai.com/purge-cache/reference/api-get-started
+#
+
 TARGET_URL=$1
 
 _url=$TARGET_URL