initial commit
[map-websocket.git] / README
1 Howdy do neighbor!
2
3 If you're reading this, then pour yourself a tasty beverage. The history of this was so that I could learn the basics of websockets.
4
5 Firstly, lets get the licensing out of the way...
6
7 ###############################################################################
8 # The MIT License (MIT)
9 # Copyright (c) Russell Handorf
10 # Other copyrights noted where code modification is located
11 #
12 # Permission is hereby granted, free of charge, to any person obtaining a copy
13 # of this software and associated documentation files (the "Software"), to deal
14 # in the Software without restriction, including without limitation the rights
15 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16 # copies of the Software, and to permit persons to whom the Software is
17 # furnished to do so, subject to the following conditions:
18 #
19 # The above copyright notice and this permission notice shall be included in
20 # all copies or substantial portions of the Software.
21 #
22 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
28 # THE SOFTWARE.
29 #
30 ###############################################################################
31
32 Download and compile: https://github.com/fw42/honeymap
33
34 In all cases for scripts, replace all instances of 'YOURSERVER' with your server's domainname, ip, or some other identifier. To make your life easier, just grep for this.
35
36 server_alienfeeds-pcap.js : This is the modified version of their map code to connect to the server.
37 server.pl : This is the server that handles "clients". mainly the injectors and nodejs instances. It acts akin to an IRC messaging system.
38 client-pcap-inject.pl : This is the perl script to sniff and inject messages. Change the MTU and network interface to your suiting.
39 client-pcapcolors-inject.pl : Pretty much the same as above, but *attempts* to add colors to the dots on the map.
40 client-syslogpipe-injext.pl : This is the perl script to crudely parse IP info out of a syslog pipe provided by syslog-ng. Can be modified to read any syslog file.