revi-archive/phorge-phorge
1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-09-19 16:58:48 +02:00
Code Issues Releases Wiki Activity

Update Aphlict documentation for new server management commands

Browse source 
Summary:
The docs are now a little out of date.

Also //possibly// we should call this `bin/notifications` or something, maybe?

Test Plan: read

Reviewers: joshuaspence

Reviewed By: joshuaspence

Subscribers: epriestley

Differential Revision: https://secure.phabricator.com/D9398
This commit is contained in:
epriestley 2014-06-05 12:40:53 -07:00
parent 8a7a7dcbf1
commit fcc2a24d63
3 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
scripts/install/update_phabricator.sh
View file

@ -30,6 +30,9 @@ git pull
# Stop daemons. # Stop daemons.
$ROOT/phabricator/bin/phd stop $ROOT/phabricator/bin/phd stop
# If running the notification server, stop it.
# $ROOT/phabricator/bin/aphlict stop
# Stop the webserver (apache, nginx, lighttpd, etc). This command will differ # Stop the webserver (apache, nginx, lighttpd, etc). This command will differ
# depending on which system and webserver you are running: replace it with an # depending on which system and webserver you are running: replace it with an
# appropriate command for your system. # appropriate command for your system.
@ -48,3 +51,6 @@ sudo /etc/init.d/httpd start
# Restart daemons. # Restart daemons.
$ROOT/phabricator/bin/phd start $ROOT/phabricator/bin/phd start
# If running the notification server, start it.
# $ROOT/phabricator/bin/aphlict start

6
src/applications/notification/setup/PhabricatorSetupCheckAphlict.php
View file

@ -37,8 +37,8 @@ final class PhabricatorSetupCheckAphlict extends PhabricatorSetupCheck {
->addRelatedPhabricatorConfig('notification.server-uri') ->addRelatedPhabricatorConfig('notification.server-uri')
->addCommand( ->addCommand(
pht( pht(
"(To start or restart the server, run this command.)\n". "(To start the server, run this command.)\n".
"phabricator/ $ sudo ./bin/aphlict")); "phabricator/ $ sudo ./bin/aphlict start"));
return; return;
} }
@ -57,7 +57,7 @@ final class PhabricatorSetupCheckAphlict extends PhabricatorSetupCheck {
->setShortName(pht('Notification Server Version')) ->setShortName(pht('Notification Server Version'))
->setName(pht('Notification Server Out of Date')) ->setName(pht('Notification Server Out of Date'))
->setMessage($message) ->setMessage($message)
->addCommand('phabricator/ $ sudo ./bin/aphlict'); ->addCommand('phabricator/ $ sudo ./bin/aphlict start');
} }
} }

4
src/docs/user/userguide/notifications.diviner
View file

@ -26,7 +26,7 @@ Phabricator implements realtime notifications using a Node.js server called
"Aphlict". To run it: "Aphlict". To run it:
- Install node.js. - Install node.js.
- Run `bin/aphlict` (this script must be run as root). - Run `bin/aphlict start` (this script must be run as root).
The server must be able to listen on port **843** and port **22280** for Aphlict The server must be able to listen on port **843** and port **22280** for Aphlict
to work. You can change the latter port in the `notification.client-uri` config, to work. You can change the latter port in the `notification.client-uri` config,
@ -67,7 +67,7 @@ NOTE: This is cumbersome. There will be better testing tools at some point.
You can run `aphlict` in the foreground to get output to your console: You can run `aphlict` in the foreground to get output to your console:
phabricator/ $ sudo ./bin/aphlict --foreground phabricator/ $ sudo ./bin/aphlict debug
You can run `support/aphlict/client/aphlict_test_client.php` to connect to the You can run `support/aphlict/client/aphlict_test_client.php` to connect to the
Aphlict server from the command line. Messages the client receives will be Aphlict server from the command line. Messages the client receives will be