User Tools

Site Tools


gettingstarted

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
gettingstarted [2007/10/03 20:00]
faltin
gettingstarted [2011/04/11 08:30]
morten fix various stale details
Line 1: Line 1:
 ====== Getting Started ====== ====== Getting Started ======
  
-This document covers ​the whole process from installing ​NAV to getting ​it up and running, monitoring your network. ​Follow these 8 steps:+Let's get started! We guide you through ​the process from installing to getting ​NAV up and running, monitoring your network. ​
  
  
-===== 1. Install ​NAV and dependencies ​=====+===== NAV in eight steps =====
  
-In principle, NAV can run on any Unix-like platform, as long as Apache, ​Perl, Python, PHP and Java are supported. +Follow these 8 steps: 
-See [[navdownload|this page]] for details.+ 
 +   - [[#Install NAV and dependencies]] 
 +   - [[#Adjust NAV configuration files]] 
 +   - [[#Start NAV daemons and cron jobs]] 
 +   - [[#Log into the web interface for the first time]] 
 +   - [[#Manage NAV user accounts, groups and privileges]] 
 +   - [[#Prepare your network equipment for management]] 
 +   - [[#Seed your database (register equipment)]] 
 +   - [[#Verify that your network is discovered]] 
 +   - Happy NAV'​ing! :-) 
 + 
 + 
 + 
 + 
 +===== Install NAV and dependencies ===== 
 + 
 +In principle, NAV can run on any Unix-like platform, as long as Apache, ​postgresql, Python and Java are supported. 
 +Several distribution packages are available or you can install NAV from source if you like.  
 +   ​* ​See our [[navdownload|download ​page]] for details. 
 + 
 + 
 + 
 + 
 +==== Smoothest install ====
  
 If you are looking for the smoothest install - go for the [[http://​pkg-nav.alioth.debian.org/​|Debian package]]. Your procedure will then be: If you are looking for the smoothest install - go for the [[http://​pkg-nav.alioth.debian.org/​|Debian package]]. Your procedure will then be:
  
-   - Install Debian +   - Follow our [[navfaq#​what_are_the_hardware_requirements|hardware requirements]]. Hook on a [[navfaq#​any_requirements_for_the_cell_phone|cell phone]], if you like. 
-   - ''​apt-get ​install nav''​ (first add a line to your sources.list,​ see [[http://​pkg-nav.alioth.debian.org/​|the package doc]]).+   - Install ​[[http://​www.debian.org/​|Debian]] 
 +   - ''​aptitude ​install nav''​ (first add a line to your sources.list,​ see [[http://​pkg-nav.alioth.debian.org/​|the package doc]]).
    - Follow the ''​REAME.Debian''​ cookbook    - Follow the ''​REAME.Debian''​ cookbook
  
  
 +==== Even easier install ====
  
-===== 2. Adjust NAV configuration files =====+  * Use our available [[navappliance|virtual appliance]] with NAV preinstalled! 
 +===== Adjust NAV configuration files =====
  
 All the NAV configuration files are gathered in the ''​etc''​ directory of NAV.  All the NAV configuration files are gathered in the ''​etc''​ directory of NAV. 
Line 27: Line 53:
    - In ''​nav.conf''​ set ''​ADMIN_MAIL''​ to the email account of your NAV administrator.    - In ''​nav.conf''​ set ''​ADMIN_MAIL''​ to the email account of your NAV administrator.
    - In ''​nav.conf''​ set ''​DOMAIN_SUFFIX''​ to your domain.    - In ''​nav.conf''​ set ''​DOMAIN_SUFFIX''​ to your domain.
-   - In ''​db.conf''​ set ''​userpw_nav''​. NAV will use this password to access the NAV database. For debugging purposes you use it yourself to access the database from the shell with ''​psql ​manage ​nav''​.+   - In ''​db.conf''​ set ''​userpw_nav''​. NAV will use this password to access the NAV database. For debugging purposes you use it yourself to access the database from the shell with ''​psql ​nav nav''​.
  
  
Line 35: Line 61:
 For details on how to configure what, see the [[navhome]]-document. For details on how to configure what, see the [[navhome]]-document.
  
-===== 3. Start NAV daemons and cron jobs ===== 
  
-Start the NAV daemons and cron jobs with ''​nav start''​. Verify that the NAV processes are running with 
-''​nav status''​ 
  
 +
 +
 +
 +
 +
 +
 +
 +
 +===== Start NAV daemons and cron jobs =====
 +
 +Start the NAV back-end processes (daemons and cron jobs) with ''​nav start''​. Verify that the NAV processes are running with
 +''​nav status''​.
 +
 +Here is an example that shows that ''​smsd''​ is down and the rest is up and running:
 <​code>​ <​code>​
-$/etc/init.d/nav status  +$/usr/sbin/nav status  
-Up: alertengine cricket eventengine ​getDeviceData getvtpvlan iptrace ​logengine mactrace maintengine ​ +Up: alertengine cricket eventengine ​ipdevpoll ​logengine mactrace maintengine networkDiscovery pping servicemon ​snmptrapd ​thresholdMon 
-networkDiscovery pping servicemon ​smsd thresholdMon+Down: smsd
 </​code>​ </​code>​
  
-If some of the processes are not running ​use ''​nav start <​processname>''​ to start it.+If some of the processes are down use ''​nav start <​processname>''​ to start it. Verify with ''​nav status''​. For more information ​ on the back-end processes, see [[backendprocesses|here]]
  
  
  
-===== 4. Log into the web interface for the first time =====+===== Log into the web interface for the first time =====
  
 When you first direct your browser to the NAV page served by your When you first direct your browser to the NAV page served by your
Line 69: Line 106:
  
  
-===== 5. Manage NAV user accounts, groups and priviliges ​=====+===== Manage NAV user accounts, groups and privileges ​=====
  
 For this task you use [[useradminpanel|the user adminstration panel]]. The task typically covers: For this task you use [[useradminpanel|the user adminstration panel]]. The task typically covers:
Line 91: Line 128:
  
  
-===== 6. Prepare your network equipment for management =====+===== Prepare your network equipment for management =====
  
    * Your network equipment needs to answer to snmp read polls, and if you use the port blocker, [[arnold]], snmp write is required as well. In any case make sure that only your NAV server (and other management serves, if any) are able to access your equipment with snmp (as snmp security is poor).    * Your network equipment needs to answer to snmp read polls, and if you use the port blocker, [[arnold]], snmp write is required as well. In any case make sure that only your NAV server (and other management serves, if any) are able to access your equipment with snmp (as snmp security is poor).
Line 108: Line 145:
  
  
-===== 7. Seed your database (register equipment) =====+===== Seed your database (register equipment) =====
  
 NAV does not autodiscover your network, you need to seed the database with key information. Seeding is covered in NAV does not autodiscover your network, you need to seed the database with key information. Seeding is covered in
Line 119: Line 156:
  
  
-===== 8. Verify that your network is discovered =====+ 
 + 
 + 
 +===== Verify that your network is discovered =====
  
 After you have registered your equipment in NAV, the background processes starts collecting information with snmp:  ​ After you have registered your equipment in NAV, the background processes starts collecting information with snmp:  ​
-   * [[backendprocesses#​getdevicedata|getDeviceData]] should notice the new IP device within ​minutesand will then classify the new box in terms of OIDs supported. This can be seen from the IP device report from the [[reporttool|report tool]].  +   * [[backendprocesses#​ipdevpoll|ipdevpoll]] should notice the new IP device within ​minutes and will start collecting ​switch/​router port information and more. Verify the status using the report tool (or network explorer). You may also check the ''​ipdevpoll.log''​ file.
-   * The next step for getDeviceData will be to gather ​switch/​router port information and more. Verify the status using the report tool (or network explorer). You may also check the ''​getDevicedata.log''​ file.+
  
-After the individual components has its collected data the [[backendprocesses#​mac-to-switch_port_collector_mactrace_getboksmacs_cam_logger|mac-to-switchport collector]] will every 15 minutes gather mac to switch port data. This will in turn be used by the  +After the individual components has its collected data [[backendprocesses#​mactrace|mactrace]] will every 15 minutes gather mac to switch port data. This will in turn be used by the  
-[[backendprocesses#​physical_topology_builder_networkdiscovery_topology|physical topology builder]] that runs every hour.+[[backendprocesses#​networkdiscovery_topology|physical topology builder]] that runs every hour.
  
-Cricket statistics collection will not start before your Cricket ​config ​tree is built.  +Cricket statistics collection will not start before your Cricket ​configuration ​tree is built.  
-[[backendprocesses#​collecting_statistics|The cricket config builder]] runs nightly, ​which you have to wait till the next moring ​to see statistics. You may however ​kickstart ​this process by manually running ''​makecricketconfig.pl''​.+[[backendprocesses#​collecting_statistics|The cricket config builder]] runs nightly, ​as a consequence ​you have to wait till the next morning ​to see statistics. You may however ​kick start this process by manually running ''​makecricketconfig.pl''​.
  
-Put simply; allow some time for your network to be fully discovered :-)+Put simply; allow some time for your network to be fully discovered ​and managed ​:-)
  
gettingstarted.txt · Last modified: 2011/04/11 08:30 by morten