====== Getting Started ======

Let's get started! We guide you through the process from installing to getting NAV up and running, monitoring your network. 


===== NAV in eight steps =====

Follow these 8 steps:

   - [[#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:

   - 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.
   - 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


==== Even easier install ====

  * 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. 



==== Mandatory adjustments ====

   - In ''nav.conf'' set ''ADMIN_MAIL'' to the email account of your NAV administrator.
   - 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 nav nav''.


==== Webfront configuration ====

A number of configuration files adjust how your NAV home page looks. They are all located in the ''etc/webfront''-directory.
For details on how to configure what, see the [[navhome]]-document.











===== 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>
$/usr/sbin/nav status 
Up: alertengine cricket eventengine ipdevpoll logengine mactrace maintengine networkDiscovery pping servicemon snmptrapd thresholdMon
Down: smsd
</code>

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]]. 



===== Log into the web interface for the first time =====

When you first direct your browser to the NAV page served by your
Apache, you are unauthenticated and will have the access privileges of
an anonymous user.

You may log in to the web interface as the user "admin", using "admin"
as your password.  It is of course extremely recommended that you
immediately change this password to something harder to guess.

The user "admin" is a member of the group "NAV Administrators", and
will therefore have access to absolutely everything in the web
interface.






===== Manage NAV user accounts, groups and privileges =====

For this task you use [[useradminpanel|the user adminstration panel]]. The task typically covers:

  * Creating new users. All users that are granted web access to NAV must have an account. If you require a large number of accounts, you can use [[ldapauthentication|LDAP]]. 

  * Users have group memberships. Each group define in turn privileges. Privileges may in the future cover more topics, for the time being they regulate:
    * which NAV tools a user can access (based on url regexp)
    * if the user can receive SMS messages from the alert system.
    Adjust existing groups privileges or add new groups as you like. 

  * Users also belong to an organization. For the time being - this registration is //not// important. When we in the future adopt authorization i.e. in the machine tracker, this setting will take effect.










===== 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).

   * NAV uses DNS to set names of the equipment. If your equipment is not registered in DNS, the IP address is used as name. Consider registering your equipment in DNS prior to seeding them into NAV (the other way around also works, but allow a decent time lag for the name to adjust).

   * NAV organizes equipment in rooms. Rooms resemble your network/server rooms and wiring closets. Think through a sensible naming scheme for your rooms. NAV also groups rooms in geographical areas called locations. 

   * NAV introduces guide lines for router interface descriptions. You are not forced to follow these, but if you do, NAV will automatically know the usage of your subnets. [[subnetsandvlans#guide_lines_for_configuring_router_interface_descriptions|Details here]].

   * NAV does not require port names for your switch ports, but we recommend that you use this to document where the switch ports connect. NAV will display this information in various tools.






===== Seed your database (register equipment) =====

NAV does not autodiscover your network, you need to seed the database with key information. Seeding is covered in
[[seedessentials|this document]].










===== Verify that your network is discovered =====

After you have registered your equipment in NAV, the background processes starts collecting information with snmp:  
   * [[backendprocesses#ipdevpoll|ipdevpoll]] should notice the new IP device within 2 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.

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#networkdiscovery_topology|physical topology builder]] that runs every hour.

Cricket statistics collection will not start before your Cricket configuration tree is built. 
[[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 and managed :-)