add note to dev docs about running dev server and git clone

This commit is contained in:
Oliver Gorwits
2013-09-23 20:21:40 +01:00
parent 622bd629cb
commit 2bc5a8dec0
2 changed files with 45 additions and 10 deletions

View File

@@ -40,10 +40,9 @@ Pass the C<--port> parameter to any of the web scripts. For example:
=head1 Listening Address for the Web Frontend
Pass the C<--listen> parameter to any of the web scripts. Note that you always
must include the port number. For example:
Pass the C<--host> parameter to any of the web scripts. For example:
~/bin/netdisco-web start --listen=127.0.0.1:8080
~/bin/netdisco-web start --host=127.0.0.1
=head1 Behind a Proxy
@@ -85,13 +84,6 @@ You are instead recommended to run C<netdisco-web> behind a reverse proxy as
described elsewhere in this document. Apache can easily act as an SSL reverse
proxy.
=head1 SQL and HTTP Trace
For SQL debugging try the following commands:
DBIC_TRACE_PROFILE=console DBIC_TRACE=1 ~/bin/localenv starman ~/bin/netdisco-web-fg --workers=1 --disable-keepalive
DBIC_TRACE_PROFILE=console DBIC_TRACE=1 ~/bin/localenv ~/bin/netdisco-daemon-fg
=head1 Further Reading...
Other ways to run and host the web application can be found in the

View File

@@ -7,6 +7,49 @@ App::Netdisco::Manual::Developing - Notes for contributors
This document aims to help developers understand the intent and design of the
code within Netdisco. Patches and feedback are always welcome :-)
=head1 TLDR; I want to clone git and run the web server.
First do a normal App::Netdisco install into a dedicated user's home, as per
the L<documentation|App::Netdisco>. Then:
su - netdisco && cd $HOME
mkdir git && cd git
git clone git://git.code.sf.net/p/netdisco/netdisco-ng netdisco-ng
cd netdisco-ng/Netdisco
~/bin/localenv DBIC_TRACE_PROFILE=console DBIC_TRACE=1 plackup -R share,lib -p 5001 bin/netdisco-web-fg
The above creates you a git clone (change the URL if you're a Netdisco
Developer) and runs the web server:
=over 4
=item *
In the foreground
=item *
Using a single process only (no forking)
=item *
With L<DBIx::Class> tracing
=item *
On port 5001 so it won't conflict with any already-running web frontend
=item *
Restarts the web server when you save a file in the C<share> or C<lib> directory
=back
You should be able to work out something similar for
C<bin/netdisco-daemon-fg>, too. Happy hacking!
=head1 Introduction
This release of Netdisco is built as a L<Dancer> application, and uses many