Skip to content

Commit 34fde32

Browse files
committed
Update documentation for api.pl
Now that api.pl is used for all access, update the documentation to reflect it.
1 parent f9425d2 commit 34fde32

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

bin/api.pl

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,34 @@
55

66
=head2 DESCRIPTION
77
8+
This is the API web server interface.
9+
10+
# On vagrant VM
11+
./bin/run morbo bin/api.pl
12+
13+
To run the api web server, run the following on one of the servers:
14+
15+
# Run the daemon on a local port (tunnel to display on your browser)
16+
./bin/run bin/api.pl daemon
17+
818
Start Minion worker on vagrant:
919
1020
cd /home/vagrant/metacpan-api
11-
./bin/run bin/queue.pl minion worker
21+
./bin/run bin/api.pl minion worker
1222
1323
Get status on jobs and workers.
1424
1525
On production:
1626
17-
sh /home/metacpan/bin/metacpan-api-carton-exec bin/queue.pl minion job -s
27+
sh /home/metacpan/bin/metacpan-api-carton-exec bin/api.pl minion job -s
1828
1929
On vagrant:
2030
2131
cd /home/vagrant/metacpan-api
22-
./bin/run bin/queue.pl minion job -s
32+
./bin/run bin/api.pl minion job -s
2333
2434
=cut
2535

26-
# For vagrant
2736
use lib 'lib';
2837

2938
# Start command line interface for application

lib/MetaCPAN/API.pm

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,18 @@ package MetaCPAN::API;
22

33
=head1 DESCRIPTION
44
5-
This is not a web app. It's purely here to manage the API's release indexing
6-
queue.
5+
This is the API web server interface.
76
87
# On vagrant VM
9-
./bin/run morbo bin/queue.pl
8+
./bin/run morbo bin/api.pl
109
1110
# Display information on jobs in queue
12-
./bin/run bin/queue.pl minion job
11+
./bin/run bin/api.pl minion job -s
1312
14-
To run the minion admin web interface, run the following on one of the servers:
13+
To run the api web server, run the following on one of the servers:
1514
1615
# Run the daemon on a local port (tunnel to display on your browser)
17-
./bin/run bin/queue.pl daemon
16+
./bin/run bin/api.pl daemon
1817
1918
=cut
2019

0 commit comments

Comments
 (0)