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

update install doc to remove config which is now implicit

Browse Source
This commit is contained in:
Oliver Gorwits
2013-03-05 19:26:26 +00:00
parent 6cf40b0807
commit 5511005a23
1 changed files with 31 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -14,11 +14,17 @@ BEGIN {
or not -f file($ENV{DANCER_APPDIR}, 'config.yml')) { or not -f file($ENV{DANCER_APPDIR}, 'config.yml')) {
my $auto = dir(dist_dir('App-Netdisco'))->absolute; my $auto = dir(dist_dir('App-Netdisco'))->absolute;
my $home = ($ENV{NETDISCO_HOME} || $ENV{HOME});
$ENV{DANCER_APPDIR} ||= $auto->stringify; $ENV{DANCER_APPDIR} ||= $auto->stringify;
$ENV{DANCER_CONFDIR} ||= $auto->stringify; $ENV{DANCER_CONFDIR} ||= $auto->stringify;
$ENV{DANCER_ENVDIR} ||= $auto->subdir('environments')->stringify; my $test_envdir = dir($home, 'environments');
$ENV{DANCER_ENVDIR} ||= (-f $test_envdir
? $test_envdir->stringify : $auto->subdir('environments')->stringify);
$ENV{PLACK_ENV} ||= 'deployment';
$ENV{DANCER_PUBLIC} ||= $auto->subdir('public')->stringify; $ENV{DANCER_PUBLIC} ||= $auto->subdir('public')->stringify;
$ENV{DANCER_VIEWS} ||= $auto->subdir('views')->stringify; $ENV{DANCER_VIEWS} ||= $auto->subdir('views')->stringify;
} }
@@ -83,17 +89,21 @@ PostgreSQL user for the Netdisco application:
=head1 Installation =head1 Installation
The following is a general guide which works well in most circumstances. It
assumes you have a user C<netdisco> on your system, that you want to perform
an on-line installation, and have the application run self-contained from
within that user's home. There are alternatives: see the
L<Deployment|App::Netdisco::Manual::Deployment> documentation for further
details.
To avoid muddying your system, use the following script to download and To avoid muddying your system, use the following script to download and
install Netdisco and its dependencies into the C<netdisco> user's home area install Netdisco and its dependencies into the C<netdisco> user's home area
(C<~netdisco/perl5>). (C<~netdisco/perl5>):
su - netdisco su - netdisco
curl -L http://cpanmin.us/ | perl - --notest --quiet \ curl -L http://cpanmin.us/ | perl - --notest --verbose --local-lib ~/perl5 App::Netdisco
--local-lib ~/perl5 \
App::cpanminus App::local::lib::helper App::Netdisco
Link some of the newly installed apps into the C<netdisco> user's C<$PATH>, Link some of the newly installed apps into a handy location:
e.g. C<~netdisco/bin>:
mkdir ~/bin mkdir ~/bin
ln -s ~/perl5/bin/{localenv,netdisco-*} ~/bin/ ln -s ~/perl5/bin/{localenv,netdisco-*} ~/bin/
@@ -109,8 +119,8 @@ Make a directory for your local configuration and copy the configuration
template from this distribution: 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/deployment.yml ~/environments
chmod +w ~/environments/development.yml chmod +w ~/environments/deployment.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>).
@@ -125,32 +135,29 @@ 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 data) and some MIBs if you want to run the daemon. The following script will
take care of all this for you: take care of all this for you:
DANCER_ENVDIR=~/environments ~/bin/localenv netdisco-deploy ~/bin/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
=head1 Startup =head1 Startup
Run the following command to start the web-app server as a daemon (port 5000): Run the following command to start the web-app server as a backgrounded daemon
(listening on port 5000):
DANCER_ENVDIR=~/environments ~/bin/netdisco-web start ~/bin/netdisco-web start
Run the following command to start the job control daemon (port control, etc): Run the following command to start the job control daemon (port control, etc):
DANCER_ENVDIR=~/environments ~/bin/netdisco-daemon start ~/bin/netdisco-daemon start
You should (of course) avoid running this Netdisco daemon and the legacy You should take care not to run this Netdisco daemon and the legacy daemon at
daemon at the same time. the same time.
=head1 Upgrading =head1 Upgrading
Simply install this module again, then upgrade the database schema: Simply install this module again, then upgrade the database schema:
~/bin/localenv cpanm --quiet --notest App::Netdisco ~/bin/localenv cpanm --notest App::Netdisco
DANCER_ENVDIR=~/environments ~/bin/localenv netdisco-deploy ~/bin/netdisco-deploy
~/bin/netdisco-web restart
=head1 Tips and Tricks =head1 Tips and Tricks
@@ -164,11 +171,8 @@ or MAC addreses, VLAN numbers, and so on.
For SQL debugging try the following commands: For SQL debugging try the following commands:
DBIC_TRACE_PROFILE=console DBIC_TRACE=1 \ DBIC_TRACE_PROFILE=console DBIC_TRACE=1 ~/bin/netdisco-web-fg
DANCER_ENVDIR=~/environments ~/bin/localenv plackup ~/bin/netdisco-web-fg DBIC_TRACE_PROFILE=console DBIC_TRACE=1 ~/bin/netdisco-daemon-fg
DBIC_TRACE_PROFILE=console DBIC_TRACE=1 \
DANCER_ENVDIR=~/environments ~/bin/localenv netdisco-daemon-fg
=head2 Deployment =head2 Deployment