From ae307f30b38bd75b2fb1306e726e80be3f77666d Mon Sep 17 00:00:00 2001 From: Oliver Gorwits Date: Tue, 5 Mar 2013 23:19:19 +0000 Subject: [PATCH] documentation fixups --- Netdisco/Changes | 6 ++++++ Netdisco/META.yml | 2 +- Netdisco/bin/nd-dbic-versions | 6 +++++- Netdisco/bin/netdisco-db-deploy | 6 +++++- Netdisco/bin/netdisco-deploy | 6 +++++- Netdisco/lib/App/Netdisco.pm | 19 +++++++++++++------ .../lib/App/Netdisco/Manual/Deployment.pod | 16 ++++++++++++++-- 7 files changed, 49 insertions(+), 12 deletions(-) diff --git a/Netdisco/Changes b/Netdisco/Changes index 6a522915..ec63424b 100644 --- a/Netdisco/Changes +++ b/Netdisco/Changes @@ -1,3 +1,9 @@ +2.005000_004 - 2013-03-05 + + [ENHANCEMENTS] + + * Documentation fixups + 2.005000_003 - 2013-03-05 [NEW FEATURES] diff --git a/Netdisco/META.yml b/Netdisco/META.yml index dbe531dd..36b71a3d 100644 --- a/Netdisco/META.yml +++ b/Netdisco/META.yml @@ -55,4 +55,4 @@ resources: homepage: http://netdisco.org/ license: http://opensource.org/licenses/bsd-license.php repository: git://netdisco.git.sourceforge.net/gitroot/netdisco/netdisco-ng -version: 2.005000_003 +version: 2.005000_004 diff --git a/Netdisco/bin/nd-dbic-versions b/Netdisco/bin/nd-dbic-versions index 329953c4..0e4148c9 100755 --- a/Netdisco/bin/nd-dbic-versions +++ b/Netdisco/bin/nd-dbic-versions @@ -10,7 +10,11 @@ use Dancer::Plugin::DBIC 'schema'; use App::Netdisco::DB; use Getopt::Long; -=head1 nd-dbic-versions +=head1 NAME + +nd-dbic-versions - Create DB Schema Versions for Netdisco + +=head2 USAGE This script creates SQL DDL files of the Netdisco database schema. diff --git a/Netdisco/bin/netdisco-db-deploy b/Netdisco/bin/netdisco-db-deploy index fcf39172..ea75fbef 100755 --- a/Netdisco/bin/netdisco-db-deploy +++ b/Netdisco/bin/netdisco-db-deploy @@ -9,7 +9,11 @@ use Dancer::Plugin::DBIC 'schema'; use Try::Tiny; -=head1 netdisco-db-deploy +=head1 NAME + +netdisco-db-deploy - Database deployment for Netdisco + +=head2 USAGE This script upgrades or initialises a Netdisco database schema. diff --git a/Netdisco/bin/netdisco-deploy b/Netdisco/bin/netdisco-deploy index d2b040c9..b3e9d863 100755 --- a/Netdisco/bin/netdisco-deploy +++ b/Netdisco/bin/netdisco-deploy @@ -45,7 +45,11 @@ use Archive::Extract; use HTTP::Tiny; use Try::Tiny; -=head1 netdisco-deploy +=head1 NAME + +netdisco-deploy - Database, OUI and MIB deployment for Netdisco + +=head2 USAGE This script deploys the Netdisco database schema, OUI data, and MIBs. Each of these is an optional service which the user is asked to confirm. diff --git a/Netdisco/lib/App/Netdisco.pm b/Netdisco/lib/App/Netdisco.pm index 33668af5..de5ac786 100644 --- a/Netdisco/lib/App/Netdisco.pm +++ b/Netdisco/lib/App/Netdisco.pm @@ -7,7 +7,7 @@ use 5.010_000; use File::ShareDir 'dist_dir'; use Path::Class; -our $VERSION = '2.005000_003'; +our $VERSION = '2.005000_004'; BEGIN { if (not length ($ENV{DANCER_APPDIR} || '') @@ -55,7 +55,8 @@ 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, speak to someone in the -C<#netdisco> IRC channel (on freenode). +C<#netdisco> IRC channel (on freenode). Before installing or upgrading please +review the latest L. =head1 Dependencies @@ -170,13 +171,19 @@ or MAC addreses, VLAN numbers, and so on. =head2 User Rights -With the default configuration user authentication is disabled and the default -"guest" user has no special privilege. To grant port and device control rights -to this user, create a row in the C table of the Netdisco database with -a username of C and the C flag set to true: +When user authentication is disabled (C) the default username is +"guest", which has no special privilege. To grant port and device control +rights to this user, create a row in the C table of the Netdisco +database with a username of C and the C flag set to true: netdisco=> insert into users (username, port_control) values ('guest', true); +=head2 Deployment Scenarios + +More documentation on how to deploy the application in other scenarios, for +example behind a web proxy, is in the +L documentation. + =head2 Database API Bundled with this distribution is a L layer for the Netdisco diff --git a/Netdisco/lib/App/Netdisco/Manual/Deployment.pod b/Netdisco/lib/App/Netdisco/Manual/Deployment.pod index eed82863..e214f982 100644 --- a/Netdisco/lib/App/Netdisco/Manual/Deployment.pod +++ b/Netdisco/lib/App/Netdisco/Manual/Deployment.pod @@ -2,6 +2,18 @@ App::Netdisco::Manual::Deployment - Tips and Tricks for Deployment +=head1 Relocating the Installation + +The installation process installs Netdisco self-contained to your home +directory. The target directory can easily be changed by setting the +C environment variable, for example: + + export NETDISCO_HOME=/opt/netdisco + +Obviously, you'll need to substitute this wherever you see "C<~>" in the +installation instructions. The Netdisco application will use this setting +itself to locate files and configuration. + =head1 Non-root Hosting Netdisco will assume its web site is hosted at the apex of your server - that @@ -33,14 +45,14 @@ referenced in the configuration like so (and use C<--path> option): ProxyPass /netdisco2 http://localhost:5000/ ProxyPassReverse /netdisco2 http://localhost:5000/ -=head2 SQL and HTTP Trace +=head1 SQL and HTTP Trace For SQL debugging try the following commands: DBIC_TRACE_PROFILE=console DBIC_TRACE=1 ~/bin/localenv ~/bin/netdisco-web-fg DBIC_TRACE_PROFILE=console DBIC_TRACE=1 ~/bin/localenv ~/bin/netdisco-daemon-fg -=head2 Further Reading... +=head1 Further Reading... Other ways to run and host the web application can be found in the L page. See also the L and L