Quick Installation Guide

Below is the result of our efforts to be able to walk you through, step by step, the process of installing SysDoc on a central server and have it monitor your systems. We've tried very hard to not leave anything out, but, hey, we're only humanoid. If you're having problems, visit our documentation pages to see if your problem has already been addressed. If not, please, .

System Requirements

Installation and Configuration

  1. Make sure you have PERL installed.
  2. Create a sysdoc folder. (Ex. /usr/local/sysdoc/)
  3. Untar the package.
  4. Make sure do_sysdoc and sysdoc are both pointing to the correct location for PERL.
  5. Create an entry in crontab for sysdoc.
    (Ex. 30 2 * * 4 /usr/local/sysdoc/bin/do_sysdoc -v | mail -s "Sysdoc Output" root@your.domain)
  6. Edit the sysdoc.hosts file to contain the systems you want to monitor and how you want to reach them.
    (Ex. ssh:bangkok)


The options supported by do_sysdoc are:

-h, -?, --help -- This option prints the options list, and a brief summary of the program.

-v, --verbose -- Displays warnings and other program messages during runtime.

-s, --sysdocpath <sysdoc_path> -- Sets the path to sysdoc to sysdoc_path.

-c, --config <host_file> -- Uses host_file instead of the default configuration file.

-w, --webpath <web_path> -- Specifies web_path as the path for output HTML files to be written. The default backup path is ’web_path/bkup’.

-b, --backup <backup_dir> -- Specifies as directory relative to web_path to backup files.

-u, --update [[ssh:|rsh:]node],... -- Backs up current target-node.html and outputs sysdoc for just that node, updating to the web directory. Without a node specified, sysdoc runs on the system where it is located.

-n, --node [[ssh:|rsh:]node],... -- Runs sysdoc for just that node and outputs to STDOUT. Without a node specified, sysdoc runs on the system where it is located.

-l, --sysdocl -- Sysdoc ’-l’ switch, use after -n

-i, --sysdoci -- Sysdoc ’-i’ switch, use after -n