Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

[3d7684]: README.txt Maximize Restore History

Download this file

README.txt    166 lines (121 with data), 7.1 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
NAME
    App::Netdisco - An open source web-based network management tool.

Introduction
    The contents of this distribution is the next major version of the
    Netdisco network management tool. See <http://netdisco.org/> for further
    information on the project.

    So far App::Netdisco provides a web frontend and a backend daemon to
    handle interactive requests such as changing port or device properties.
    There is not yet a device poller, so please still use the old Netdisco's
    discovery, arpnip, and macsuck.

    If you have any trouble getting the frontend running, please speak to
    someone in the "#netdisco" IRC channel (on freenode).

Dependencies
    Netdisco has several Perl library dependencies which will be
    automatically installed. However it's *strongly* recommended that you
    first install DBD::Pg and SNMP using your operating system packages. The
    following commands will test for the existence of them on your system:

     perl -MDBD::Pg\ 999
     perl -MSNMP\ 999

    With those two installed, we can proceed...

    Create a user on your system called "netdisco" if one does not already
    exist. We'll install Netdisco and its dependencies into this user's home
    area, which will take about 200MB including MIB files.

    Netdisco uses the PostgreSQL (Pg) database server. Install Pg and then
    change to the PostgreSQL superuser (usually "postgres"). Create a new
    database and Pg user for the Netdisco application:

     postgres:~$ createuser -DRSP netdisco
     Enter password for new role:
     Enter it again:
  
     postgres:~$ createdb -O netdisco netdisco

Installation
    To avoid muddying your system, use the following script to download and
    install Netdisco and its dependencies into the "netdisco" user's home
    area ("~netdisco/perl5").

     su - netdisco
     curl -L http://cpanmin.us/ | perl - --notest --quiet \
         --local-lib ~/perl5 \
         App::cpanminus \
         App::local::lib::helper \
         http://cpan.metacpan.org/authors/id/O/OL/OLIVER/App-Netdisco-2.00_012.tar.gz

    Link some of the newly installed apps into the "netdisco" user's $PATH,
    e.g. "~netdisco/bin":

     ln -s ~/perl5/bin/{localenv,netdisco-*} ~/bin/

    Test the installation by running the following command, which should
    only produce a status message (and throw up no errors):

     localenv netdisco-daemon status

Configuration
    Make a directory for your local configuration and copy the configuration
    template from this distribution:

     mkdir ~/environments
     cp ~/perl5/lib/perl5/auto/share/dist/App-Netdisco/environments/development.yml ~/environments
     chmod +w ~/environments/development.yml

    Edit the file and change the database connection parameters to match
    those for your local system (that is, the "dsn", "user" and "pass").

    Optionally, in the same file uncomment and edit the "domain_suffix"
    setting to be appropriate for your local site.

Bootstrap
    The database either needs configuring if new, or updating from the
    current release of Netdisco (1.x). You also need vendor MAC address
    prefixes (OUI data) and some MIBs if you want to run the daemon. The
    following script will take care of all this for you:

     DANCER_ENVDIR=~/environments localenv netdisco-deploy

    If you don't want that level of automation, check out the database
    schema diff from the current release of Netdisco, and apply it yourself:

     ~/perl5/lib/perl5/App/Netdisco/DB/schema_versions/App-Netdisco-DB-2-3-PostgreSQL.sql

Startup
    Run the following command to start the web server:

     DANCER_ENVDIR=~/environments localenv plackup ~/bin/netdisco-web

    Other ways to run and host the web application can be found in the
    Dancer::Deployment page. See also the plackup documentation.

    Run the following command to start the daemon:

     DANCER_ENVDIR=~/environments localenv netdisco-daemon start

Tips and Tricks
    The main black navigation bar has a search box which is smart enough to
    work out what you're looking for in most cases. For example device
    names, node IP or MAC addreses, VLAN numbers, and so on.

    For SQL debugging try the following command:

     DBIC_TRACE_PROFILE=console DBIC_TRACE=1 \
       DANCER_ENVDIR=~/environments plackup ~/bin/netdisco-web

    To run the job daemon in the foreground, start the "netdisco-daemon-fg"
    program instead of "netdisco-daemon".

Future Work
    The intention is to support "plugins" for additonal features, most
    notably columns in the Device Port listing, but also new menu items and
    tabs. The design of this is sketched out but not implemented. The goal
    is to avoid patching core code to add localizations or less widely used
    features.

    Bundled with this app is a DBIx::Class layer for the Netdisco database.
    This could be a starting point for an "official" DBIC layer. Helper
    functions and canned searches have been added to support the web
    interface.

Caveats
    Some sections are not yet implemented, e.g. the *Device Module* tab.

    Menu items on the main black navigation bar go nowhere, except Home.

    None of the Reports yet exist (e.g. searching for wireless devices, or
    duplex mismatches). These might be implemented as a plugin bundle.

    The Wireless, IP Phone and NetBIOS Node properies are not yet shown.

AUTHOR
    Oliver Gorwits <oliver@cpan.org>

COPYRIGHT AND LICENSE
    This software is copyright (c) 2012 by The Netdisco Developer Team.

     Redistribution and use in source and binary forms, with or without
     modification, are permitted provided that the following conditions are met:
         * Redistributions of source code must retain the above copyright
           notice, this list of conditions and the following disclaimer.
         * Redistributions in binary form must reproduce the above copyright
           notice, this list of conditions and the following disclaimer in the
           documentation and/or other materials provided with the distribution.
         * Neither the name of the Netdisco Project nor the
           names of its contributors may be used to endorse or promote products
           derived from this software without specific prior written permission.
 
     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     DISCLAIMED. IN NO EVENT SHALL THE NETDISCO DEVELOPER TEAM BE LIABLE FOR ANY
     DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.