moar documentation
This commit is contained in:
		| @@ -38,3 +38,19 @@ Daemon::Control->new({ | ||||
|   stderr_file => file($log_dir, 'netdisco-daemon.log'), | ||||
|   stdout_file => file($log_dir, 'netdisco-daemon.log'), | ||||
| })->run; | ||||
|  | ||||
| =head1 NAME | ||||
|  | ||||
| netdisco-daemon - Job Control Daemon for Netdisco | ||||
|  | ||||
| =head1 SEE ALSO | ||||
|  | ||||
| =over 4 | ||||
|  | ||||
| =item * | ||||
|  | ||||
| L<App::Netdisco> | ||||
|  | ||||
| =back | ||||
|  | ||||
| =cut | ||||
|   | ||||
| @@ -93,3 +93,19 @@ sub restart_worker { | ||||
|   debug "restarting worker $e->{wid}"; | ||||
|   $self->restart_worker($e->{wid}); | ||||
| } | ||||
|  | ||||
| =head1 NAME | ||||
|  | ||||
| netdisco-daemon-fg - Job Control for Netdisco | ||||
|  | ||||
| =head1 SEE ALSO | ||||
|  | ||||
| =over 4 | ||||
|  | ||||
| =item * | ||||
|  | ||||
| L<App::Netdisco> | ||||
|  | ||||
| =back | ||||
|  | ||||
| =cut | ||||
|   | ||||
| @@ -16,7 +16,7 @@ This script upgrades or initialises a Netdisco database schema. | ||||
| Pre-existing requirements are that there be a database table created and a | ||||
| user with rights to create tables in that database. Both the table and user | ||||
| name must match those configured in your environment YAML file (default | ||||
| C<environments/development.yml>). | ||||
| C<~/environments/deployment.yml>). | ||||
|  | ||||
| Simply run this script, which connects to the database and runs without user | ||||
| interaction. If there's no Nedisco schema, it is deployed. If there's an | ||||
| @@ -37,7 +37,7 @@ Version 2 is the "classic" Netdisco database schema as of Netdisco 1.1 | ||||
|  | ||||
| =item * | ||||
|  | ||||
| Version 3 (and onwards) adds patches for Netdisco 1.2 | ||||
| Version 5 (and onwards) adds patches for Netdisco 1.2 | ||||
|  | ||||
| =back | ||||
|  | ||||
|   | ||||
| @@ -53,7 +53,7 @@ these is an optional service which the user is asked to confirm. | ||||
| Pre-existing requirements are that there be a database table created and a | ||||
| user with rights to create tables in that database. Both the table and user | ||||
| name must match those configured in your environment YAML file (default | ||||
| C<environments/development.yml>). | ||||
| C<~/environments/deployment.yml>). | ||||
|  | ||||
| This script will download the latest MAC address vendor prefix data from the | ||||
| Internet, and update the OUI table in the database. Hence Internet access is | ||||
| @@ -71,7 +71,7 @@ say 'Before we continue, the following prerequisites must be in place:'; | ||||
| say ' * Internet access'; | ||||
| say ' * Database added to PostgreSQL for Netdisco'; | ||||
| say ' * User added to PostgreSQL with rights to the Netdisco Database'; | ||||
| say ' * "environments/development.yml" file configured with Database dsn/user/pass'; | ||||
| say ' * "~/environments/deployment.yml" file configured with Database dsn/user/pass'; | ||||
| say ' * A full backup of any existing Netdisco database data'; | ||||
| say ''; | ||||
| say 'You will be asked to confirm all changes to your system.'; | ||||
|   | ||||
| @@ -38,3 +38,19 @@ Daemon::Control->new({ | ||||
|   stderr_file => file($log_dir, 'netdisco-web.log'), | ||||
|   stdout_file => file($log_dir, 'netdisco-web.log'), | ||||
| })->run; | ||||
|  | ||||
| =head1 NAME | ||||
|  | ||||
| netdisco-web - Web Application Server for Netdisco | ||||
|  | ||||
| =head1 SEE ALSO | ||||
|  | ||||
| =over 4 | ||||
|  | ||||
| =item * | ||||
|  | ||||
| L<App::Netdisco> | ||||
|  | ||||
| =back | ||||
|  | ||||
| =cut | ||||
|   | ||||
| @@ -35,3 +35,19 @@ set plack_middlewares => [ | ||||
|  | ||||
| use App::Netdisco::Web; | ||||
| dance; | ||||
|  | ||||
| =head1 NAME | ||||
|  | ||||
| netdisco-web-fg - Web Application for Netdisco | ||||
|  | ||||
| =head1 SEE ALSO | ||||
|  | ||||
| =over 4 | ||||
|  | ||||
| =item * | ||||
|  | ||||
| L<App::Netdisco> | ||||
|  | ||||
| =back | ||||
|  | ||||
| =cut | ||||
|   | ||||
		Reference in New Issue
	
	Block a user