From fcc2a24d63e680efc4582ad3aeffe2c3a18525f0 Mon Sep 17 00:00:00 2001 From: epriestley Date: Thu, 5 Jun 2014 12:40:53 -0700 Subject: [PATCH] Update Aphlict documentation for new server management commands 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 --- scripts/install/update_phabricator.sh | 6 ++++++ .../notification/setup/PhabricatorSetupCheckAphlict.php | 6 +++--- src/docs/user/userguide/notifications.diviner | 4 ++-- 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/scripts/install/update_phabricator.sh b/scripts/install/update_phabricator.sh index 5aad808087..5a3950088e 100755 --- a/scripts/install/update_phabricator.sh +++ b/scripts/install/update_phabricator.sh @@ -30,6 +30,9 @@ git pull # Stop daemons. $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 # depending on which system and webserver you are running: replace it with an # appropriate command for your system. @@ -48,3 +51,6 @@ sudo /etc/init.d/httpd start # Restart daemons. $ROOT/phabricator/bin/phd start + +# If running the notification server, start it. +# $ROOT/phabricator/bin/aphlict start diff --git a/src/applications/notification/setup/PhabricatorSetupCheckAphlict.php b/src/applications/notification/setup/PhabricatorSetupCheckAphlict.php index fd11f58632..294fa5f84e 100644 --- a/src/applications/notification/setup/PhabricatorSetupCheckAphlict.php +++ b/src/applications/notification/setup/PhabricatorSetupCheckAphlict.php @@ -37,8 +37,8 @@ final class PhabricatorSetupCheckAphlict extends PhabricatorSetupCheck { ->addRelatedPhabricatorConfig('notification.server-uri') ->addCommand( pht( - "(To start or restart the server, run this command.)\n". - "phabricator/ $ sudo ./bin/aphlict")); + "(To start the server, run this command.)\n". + "phabricator/ $ sudo ./bin/aphlict start")); return; } @@ -57,7 +57,7 @@ final class PhabricatorSetupCheckAphlict extends PhabricatorSetupCheck { ->setShortName(pht('Notification Server Version')) ->setName(pht('Notification Server Out of Date')) ->setMessage($message) - ->addCommand('phabricator/ $ sudo ./bin/aphlict'); + ->addCommand('phabricator/ $ sudo ./bin/aphlict start'); } } diff --git a/src/docs/user/userguide/notifications.diviner b/src/docs/user/userguide/notifications.diviner index 218ef11170..6bee039045 100644 --- a/src/docs/user/userguide/notifications.diviner +++ b/src/docs/user/userguide/notifications.diviner @@ -26,7 +26,7 @@ Phabricator implements realtime notifications using a Node.js server called "Aphlict". To run it: - 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 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: - phabricator/ $ sudo ./bin/aphlict --foreground + phabricator/ $ sudo ./bin/aphlict debug 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