fix POD typo and update README

This commit is contained in:
Oliver Gorwits
2012-12-20 13:25:12 +00:00
parent b3c3897cb4
commit dd5219292e
2 changed files with 26 additions and 10 deletions

View File

@@ -98,7 +98,7 @@ template from this distribution:
mkdir ~/environments mkdir ~/environments
cp ~/perl5/lib/perl5/auto/share/dist/App-Netdisco/environments/development.yml ~/environments cp ~/perl5/lib/perl5/auto/share/dist/App-Netdisco/environments/development.yml ~/environments
chmod +w ~/environments/developemnt.yml chmod +w ~/environments/development.yml
Edit the file and change the database connection parameters to match those for Edit the file and change the database connection parameters to match those for
your local system (that is, the C<dsn>, C<user> and C<pass>). your local system (that is, the C<dsn>, C<user> and C<pass>).

View File

@@ -6,9 +6,13 @@ Introduction
Netdisco network management tool. See <http://netdisco.org/> for further Netdisco network management tool. See <http://netdisco.org/> for further
information on the project. information on the project.
If you have any trouble getting the frontend running, or it blows up in So far App::Netdisco provides a web frontend and a backend daemon to
your face, please speak to someone in the "#netdisco" IRC channel (on handle interactive requests such as changing port or device properties.
freenode). 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 Dependencies
Netdisco has several Perl library dependencies which will be Netdisco has several Perl library dependencies which will be
@@ -63,7 +67,7 @@ Configuration
mkdir ~/environments mkdir ~/environments
cp ~/perl5/lib/perl5/auto/share/dist/App-Netdisco/environments/development.yml ~/environments cp ~/perl5/lib/perl5/auto/share/dist/App-Netdisco/environments/development.yml ~/environments
chmod +w ~/environments/developemnt.yml chmod +w ~/environments/development.yml
Edit the file and change the database connection parameters to match Edit the file and change the database connection parameters to match
those for your local system (that is, the "dsn", "user" and "pass"). those for your local system (that is, the "dsn", "user" and "pass").
@@ -72,6 +76,18 @@ Configuration
setting to be appropriate for your local site. setting to be appropriate for your local site.
Bootstrap 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/Netdisco-DB-2-3-PostgreSQL.sql
Startup Startup
Run the following command to start the web server: Run the following command to start the web server:
@@ -116,8 +132,8 @@ Caveats
The Wireless, IP Phone and NetBIOS Node properies are not yet shown. The Wireless, IP Phone and NetBIOS Node properies are not yet shown.
AUTHORS AUTHOR
* Oliver Gorwits <oliver@cpan.org> Oliver Gorwits <oliver@cpan.org>
COPYRIGHT AND LICENSE COPYRIGHT AND LICENSE
This software is copyright (c) 2012 by The Netdisco Developer Team. This software is copyright (c) 2012 by The Netdisco Developer Team.