Browse Source
Propagated changes PKG-SNF4CGP-WIN/trunk/CGPSNF/Doc/default.html
Doc/default.html.in (except that 64-bit module download links are still active). git-svn-id: https://svn.microneil.com/svn/PKG-SNF4CGP-NIX/trunk@51 7ef522f6-be79-40a8-b7df-0a85b3383509master
1 changed files with 143 additions and 74 deletions
+ 143
- 74
SNF4CGP_Developer_Package/Doc/default.html.in
View File
| @@ -234,7 +234,7 @@ You can build the Sniffer Plugin from source: | |||
| cd snf4cgp-X.Y.Z</tt><br> | |||
| <li>Configure and build the system:<tt><br> | |||
| ./configure<br> | |||
| make</tt><br> | |||
| ./make</tt><br> | |||
| <li>Become super-user (root). | |||
| <li>Create the Sniffer Plugin:<tt><br> make | |||
| module</tt><br> This creates a Plugin archive | |||
| @@ -246,69 +246,132 @@ You can build the Sniffer Plugin from source: | |||
| <h3><hr><a name=Config></a>Configuring the Sniffer Plugin.</h3> | |||
| <p>In the module directory (<tt>/var/CommuniGate/CGPSNF</tt> on a | |||
| Linux or Linux-like system):</p> | |||
| <p>Go to the CGPSNF module directory:<br/> | |||
| <blockquote> | |||
| On a typical Linux or Linux-like system | |||
| <tt>/var/CommuniGate/CGPSNF</tt><br/> On a typical Windows system | |||
| <tt>C:\CommuniGatePro\CGPSNF</tt><br/> | |||
| <br/> | |||
| <i>Note: If these are not correct for your system you will need to | |||
| customize your snf_engine.xml and getRulebase script accordingly. Be sure | |||
| you visit the <a | |||
| href="http://www.armresearch.com/support/articles/software/snfServer/config/node/paths/">paths</a> and <a href="http://www.armresearch.com/support/articles/software/snfServer/config/node/network/update-script.jsp">update-script</a> section of snf_engine.xml as well | |||
| as | |||
| the SET SNIFFER_PATH= line in your getRulebase script. </i> </blockquote> | |||
| </p> | |||
| <ul> | |||
| <li>Copy the configuration file <tt><br> | |||
| snf_engine.xml.sample</tt><br> to <tt><br> | |||
| snf_engine.xml</tt><br> and customize as | |||
| needed. Please see the <a href="http://www.armresearch.com">ARM | |||
| Research Labs web site</a> for documentation on | |||
| the <tt>snf_engine.xml</tt> configuration file.<br> | |||
| <li>Copy <tt><br> | |||
| identity.xml.sample</tt><br> to <tt><br> | |||
| identity.xml</tt><br> and edit to include the | |||
| license ID and authentication attributes of | |||
| the <tt><identity> element</tt>.<br> | |||
| <li>Copy <tt><br> | |||
| getRulebase.sample</tt><br> to <tt><br> | |||
| getRulebase</tt><br> and edit to include the | |||
| license ID and authentication: | |||
| <ul> | |||
| <li>Change the line <tt><br> | |||
| AUTHENTICATION=authenticationxx</tt><br> | |||
| to <tt><br> | |||
| AUTHENTICATION=YOUR_AUTHENTICATION</tt><br> | |||
| where <tt>YOUR_AUTHENTICATION</tt> is authentication code | |||
| obtained from ARM Research Labs.</LI> | |||
| <li>Change the line <tt><br> | |||
| LICENSE_ID=licenseid</tt><br> to <tt><br> | |||
| LICENSE_ID=YOUR_LICENSE_ID</tt><br> | |||
| where <tt>YOUR_LICENSE_ID</tt> is license ID obtained from | |||
| ARM Research Labs.</LI> | |||
| </ul> | |||
| <li>Make <tt>getRulebase</tt> executable:<tt><br> | |||
| chmod 755 getRulebase</tt><br> | |||
| <li>Copy <tt><br> | |||
| GBUdbIgnoreList.txt.sample</tt><br> to <tt><br> | |||
| GBUdbIgnoreList.txt</tt><br> and customize as | |||
| needed. Please see the | |||
| <a href="http://www.armresearch.com">ARM Research Labs web | |||
| site</a> for documentation on the <tt>GBUdbIgnoreList.txt</tt> | |||
| file.<br> | |||
| <li>Download the Sniffer database: | |||
| <ul> | |||
| <li>Create the file <tt>UpdateReady.txt</tt> in the plugin directory:<tt><br> | |||
| touch UpdateReady.txt</tt><br> | |||
| </LI> | |||
| <li>Run the <tt>getRulebase</tt> script in the plugin | |||
| directory:<tt><br> | |||
| ./getRulebase</tt><br> | |||
| This downloads the Sniffer database to the plugin directory. | |||
| </ul> | |||
| The <B><tt>CGPSNF</tt></B> program automatically updates the | |||
| Sniffer database as needed. | |||
| <li>Proceed with <a HREF="#Test">Testing the Sniffer Plugin</a>. | |||
| <li>Have your Message Sniffer <i>LicenseID</i> (8 characters) and | |||
| <i>AuthenticationString</i> (16 characters) ready. You should have | |||
| received these in your sign-up email or in one of your update | |||
| notification email's from ARM Research Labs. | |||
| </li> | |||
| <br/> | |||
| <li>Copy the sample configuration files.</li> | |||
| <ul> | |||
| <li>Copy <tt>snf_engine.xml.sample</tt> to <tt>snf_engine.xml</tt> | |||
| and <a | |||
| href="http://www.armresearch.com/support/articles/software/snfServer/config/snfEngine.jsp"> | |||
| Customize as needed. | |||
| </a> | |||
| <blockquote><i>Note: If you modify the location of your rulebase | |||
| you will also need to modify your getRulebase script accordingly! | |||
| This is supported, however it is usually best to leave the location | |||
| of the rulebase (.snf) files in the CGPSNF directory.</i></blockquote> | |||
| </li> | |||
| <li>Copy <tt>identity.xml.sample</tt> to <tt>identity.xml</tt> </li> | |||
| <li>Edit <tt>identity.xml</tt> to <a | |||
| href="http://www.armresearch.com/support/articles/software/snfServer/config/identity.jsp">Configure your <i>LicenseID</i> and | |||
| <i>AuthenticationString</i></a></li> | |||
| <li>Copy | |||
| <tt>GBUdbIgnoreList.txt.sample</tt> to <tt>GBUdbIgnoreList.txt</tt> | |||
| and <a | |||
| href="http://www.armresearch.com/support/articles/software/snfServer/config/gbudbIgnoreList.jsp">Customize as needed.</a></li> | |||
| </ul> | |||
| <br/> | |||
| <li>Configure your automated updates script.</li> | |||
| <ul> | |||
| <br/> | |||
| <li>On Windows Systems...</li> | |||
| <ul> | |||
| <li>Copy <tt>getRulebase.cmd.sample</tt> to | |||
| <tt>getRulebase.cmd</tt></li> | |||
| <li>Configure the script with your SNF license ID and | |||
| Authentication string.</li> | |||
| <ul> | |||
| <li>Change the line <tt>LICENSE_ID=licenseid</tt> to | |||
| <tt>LICENSE_ID=</tt><i>your_LicenseID</i></li> | |||
| <li>Change the line | |||
| <tt>AUTHENTICATION=authenticationxx</tt> to | |||
| <tt>AUTHENTICATION=</tt><i>your_AuthenticationString</i></li> | |||
| </ul> | |||
| </ul> | |||
| <br/> | |||
| <li>On Linux Sysetms...</li> | |||
| <ul> | |||
| <li>Copy <tt>getRulebase.sample</tt> to | |||
| <tt>getRulebase</tt></li> | |||
| <li>Configure the script with your SNF license ID and | |||
| Authentication string.</li> | |||
| <ul> | |||
| <li>Change the line <tt>LICENSE_ID=licenseid</tt> to | |||
| <tt>LICENSE_ID=</tt><i>your_LicenseID</i></li> | |||
| <li>Change the line | |||
| <tt>AUTHENTICATION=authenticationxx</tt> to | |||
| <tt>AUTHENTICATION=</tt><i>your_AuthenticationString</i></li> | |||
| </ul> | |||
| <li>Make <tt>getRulebase</tt> executable:<br/> | |||
| <tt>chmod 755 getRulebase</tt></li> | |||
| </ul> | |||
| </ul> | |||
| <br/> | |||
| <li>Download the current Message Sniffer rulebase: | |||
| <ul> | |||
| <br/> | |||
| <li>On Windows systems...</li> | |||
| <ul> | |||
| <li>Create an <tt>UpdateReady.txt</tt> file:<tt><br> | |||
| echo . > UpdateReady.txt</tt><br> | |||
| </li> | |||
| <li>Run the <tt>getRulebase</tt> script:<tt><br> | |||
| getRulebase</tt><br> | |||
| <li>Check for a new rulebase (.snf) file<br/> | |||
| <tt>dir *.snf</tt></li> | |||
| </ul> | |||
| <br/> | |||
| <li>On Linux systems...</li> | |||
| <ul> | |||
| <li>Create an <tt>UpdateReady.txt</tt> file:<tt><br> | |||
| touch UpdateReady.txt</tt><br> | |||
| </li> | |||
| <li>Run the <tt>getRulebase</tt> script:<tt><br> | |||
| ./getRulebase</tt><br> | |||
| <li>Check for a new rulebase (.snf) file<br> | |||
| <tt>ls *.snf</tt><br> | |||
| </ul> | |||
| </ul> | |||
| <blockquote><i>Note: The <B><tt>CGPSNF</tt></B> program will | |||
| automatically run the getRulebase | |||
| script as needed. However there must be a valid rulebase file present | |||
| before the CGPSNF program will run. This step also helps you verify that | |||
| the getRulebase script is configured correctly. If it is you will see a | |||
| new .snf file after running the script</i></blockquote> | |||
| <li>Proceed with <a HREF="#Test">Testing the Sniffer Plugin.</a></li> | |||
| </ul> | |||
| <h3><hr><a name=Test></a>Testing the Sniffer Plugin.</h3> | |||
| @@ -319,14 +382,18 @@ You can build the Sniffer Plugin from source: | |||
| cd \CommuniGatePro\CGPSNF</tt><br> | |||
| <li>Launch the <tt>CGPSNF.exe</tt> application by typing:<tt><br> | |||
| CGPSNF.exe</tt><br> | |||
| CGPSNF</tt><br> | |||
| It will report the Plugin version number and build date.<br> | |||
| <li>Type:<tt><br> | |||
| 1 FILE junkmsg.msg</tt><br> | |||
| The plugin should report that the file is spam. | |||
| <li>Quit <tt>CGPSNF.exe</tt> by typing Ctrl-Z. | |||
| </ul> | |||
| <li>Type: <br> | |||
| <tt>1 FILE junkmsg.txt</tt><br> The plugin should | |||
| report that the file is spam. | |||
| <li>Close the progrm by typing<br> | |||
| <tt>2 QUIT</tt> | |||
| </ul> | |||
| <p>On a Unix System:</p> | |||
| <ul> | |||
| @@ -337,12 +404,14 @@ You can build the Sniffer Plugin from source: | |||
| ./CGPSNF</tt><br> | |||
| It will report the Plugin version number and build date.<br> | |||
| <li>Type:<tt><br> | |||
| 1 FILE junkmsg.txt</tt><br> | |||
| the plugin should report that the file is spam. | |||
| <li>Type:<br> | |||
| <tt>1 FILE junkmsg.txt</tt><br> | |||
| the plugin should report that the file is spam. | |||
| <li>Quit <tt>CGPSNF</tt> by typing Ctrl-D. | |||
| </ul> | |||
| <li>Close the program by typing<br> | |||
| <tt>2 QUIT</tt> | |||
| </ul> | |||
| <h3><hr><a name="Options"></a>Command Line Options</h3> | |||
| <dl> | |||
Loading…