apps/silcmap/README

   1 The SILC Map
   2 ============
   3
   4 SILC Map is a utility which can be used to visualize the topology of a
   5 SILC network.  It can create maps which indicate the exact global position
   6 of the servers and it can create HTML pages out of the information it
   7 gathers from the servers.  It is also possible to create a HTML map
   8 page which allows the user to click the servers on the map image to get
   9 more detailed information of the server.  The links between the routers
  10 and servers can also be drawn on the map image.
  11
  12 The HTML pages that SILC Map creates are by default crude looking.  This
  13 is intentional feature to allow the user to easily embed the data pages
  14 into existing web site.  This can be done for example by using PHP, server
  15 side includes or similar method.
  16
  17
  18 SILC Map Config File
  19 ====================
  20
  21 By default the SILC Map reads the silcmap.conf file.  Please read the
  22 example silcmap.conf file to learn all the possible commands and
  23 configuration options you can use to alter the behavior of the SILC Map.
  24
  25
  26 Running the SILC Map
  27 ====================
  28
  29 After you have configured the silcmap.conf file, simply run the ./silcmap
  30 program.  It reads the file, the source map image, creates the connections
  31 to SILC servers and producess the target image and HTML pages.  After the
  32 map is created the silcmap program exits.  If you want to periodically run
  33 the silcmap to generate maps you may create for example an at (see at(1))
  34 job on your local system.
  35
  36
  37 Getting Map Images
  38 ==================
  39
  40 We do not distribute any map images with the SILC Map package.  However,
  41 you may download map images for free from NASA at:
  42 http://earthobservatory.nasa.gov/Newsroom/BlueMarble/.
  43
  44
  45 Contact
  46 =======
  47
  48 Feedback and comments are welcome.  Bug reports should be sent to the
  49 SILC development mailing list.
  50
  51 Official SILC project web site      : http://silcnet.org/
  52 FTP archive for SILC project        : ftp://ftp.silcnet.org/
  53 Development mailing list address    : silc-devel@lists.silcnet.org
  54