{\rtf1\ansi\ansicpg1252\cocoartf1504\cocoasubrtf830
{\fonttbl\f0\fswiss\fcharset0 Helvetica;}
{\colortbl;\red255\green255\blue255;}
{\*\expandedcolortbl;;}
\margl1440\margr1440\vieww12820\viewh10560\viewkind0
\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\qc\partightenfactor0

\f0\fs28 \cf0 Validate External Links\
by Iritscen\
\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\partightenfactor0
\cf0 \
The ValExtLinks script is a Bash shell script developed on a Mac, but hopefully any Bash shell from v3.2 onward can run it.  Non-Bash shells will not work, as there is a lot of Bash-specific syntax in this script.  The script invokes Unix binaries that are mostly pretty standard, but you might want to make sure that you have "curl" and "expect" installed.\
\
The purpose of this read-me is not to tell you how to use the script.  Running the script with the --help option should give you that information.  This read-me simply intends to draw your attention to the following items that you may or will need to adapt to your system before you can use ValExtLinks:\
\
- "Run validate_external_links.command" is intended to be the means of running the script.  The idea is to make sure this file is executable and then to double-click it (or invoke it from a cron event) when you want to run ValExtLinks.  First you will need to set the variables at the top of the script to be correct for your system.\
\
- For testing and development, please note the following:\
	- You can use the _LOCAL variables in "Run validate_external_links.command" to supply the exact links and exceptions that you want the script to process.  Alternate invocations of ValExtLinks are also provided for testing purposes.\
	- Currently, the extlinks.csv file hosted on oni2.net refreshes twice a day, at 06:20 and 14:20 GMT.\
	- The "Sample files" folder contains:\
		- extlinks.csv: the current format of oni2.net's wiki link dump.\
		- header.txt: an example of what "curl" sees when it is run with the --head option.\
		- ValExtLinks report.htm/.rtf/.txt: a reference sample of the output you should get.\
\
- sftp_login.txt should be populated with your SFTP login info and the path that you want the report uploaded to.  The ValExtLinks script will parse this file and pass its info to val_expect_sftp.txt, which performs the actual upload of the ValExtLinks report.  The script was written to use SFTP because Oni2.net does not support regular FTP.\
\
- The AGENT variable should contain a reasonably up-to-date user agent string, preferably generated from Google Chrome since that is the browser used to take screenshots of pages.  There are different web sites you can visit in the browser to learn the user agent string, or you can simply upload and then visit the supplied print_agent.php.\
\
- The CHROME variable should be set to a version of Google Chrome on your computer that is capable of saving screenshots of web pages.\
\
- The CURL_CODES and HTTP_CODES variables need to be set to wherever you are uploading those two files so that the reader can be directed to them properly from the header of the ValExtLinks report.\
\
Have fun validating those external links!}