135/netdisco
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

documentation fixups

Browse Source
This commit is contained in:
Oliver Gorwits
2013-03-05 23:19:19 +00:00
parent 069e1a22bc
commit ae307f30b3
7 changed files with 49 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
Netdisco/lib/App/Netdisco.pm
View File

@@ -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<Release Notes|App::Netdisco::Manual::ReleaseNotes>.
=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<users> table of the Netdisco database with
a username of C<guest> and the C<port_control> flag set to true:
When user authentication is disabled (C<no_auth>) 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<users> table of the Netdisco
database with a username of C<guest> and the C<port_control> 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<Deployment|App::Netdisco::Manual::Deployment> documentation.
=head2 Database API
Bundled with this distribution is a L<DBIx::Class> layer for the Netdisco

16
Netdisco/lib/App/Netdisco/Manual/Deployment.pod
View File

@@ -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<NETDISCO_HOME> 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<Dancer::Deployment> page. See also the L<plackup> and L<starman>