Changeset View
Changeset View
Standalone View
Standalone View
src/docs/user/configuration/notifications.diviner
| Show First 20 Lines • Show All 53 Lines • ▼ Show 20 Lines | |||||
| Running the Aphlict Server | Running the Aphlict Server | ||||
| ========================== | ========================== | ||||
| After installing Node.js, you can control the notification server with the | After installing Node.js, you can control the notification server with the | ||||
| `bin/aphlict` command. To start the server: | `bin/aphlict` command. To start the server: | ||||
| phabricator/ $ bin/aphlict start | phabricator/ $ bin/aphlict start | ||||
| The server must be able to listen on port **22280** for Aphlict to work. In | By default, the server must be able to listen on port `22280`. If you're using | ||||
| particular, if you're running in EC2, you need to unblock this port in the | a host firewall (like a security group in EC2), make sure traffic can reach the | ||||
| server's security group configuration. You can change this port in the | server. | ||||
| `notification.client-uri` config. | |||||
| The server configuration is controlled by a configuration file, which is | |||||
| You may need to adjust these settings: | separate from Phabricator's configuration settings. The default file can | ||||
| be found at `phabricator/conf/aphlict/aphlict.default.json`. | |||||
| - `notification.ssl-cert` Point this at an SSL certificate for secure | |||||
| WebSockets. | To make adjustments to the default configuration, either copy this file to | ||||
| - `notification.ssl-key` Point this at an SSL keyfile for secure WebSockets. | create `aphlict.custom.json` in the same directory (this file will be used if | ||||
| it exists) or specify a configuration file explicitly with the `--config` flag: | |||||
| phabricator/ $ bin/aphlict start --config path/to/config.json | |||||
| The configuration file has these settings: | |||||
| - `servers`: A list of servers to start. | |||||
| In particular, if your server uses HTTPS, you **must** configure these options. | Each server in the `servers` list should be an object with these keys: | ||||
| Browsers will not allow you to use non-SSL websockets from an SSL web page. | |||||
| - `type`: //Required string.// The type of server to start. Options are | |||||
| `admin` or `client`. Normally, you should run one of each. | |||||
| - `port`: //Required int.// The port this server should listen on. | |||||
| - `listen`: //Optional string.// Which interface to bind to. By default, | |||||
| the `admin` server is bound to localhost (so only other services on the | |||||
| local machine can connect to it), while the `client` server is bound | |||||
| to `0.0.0.0` (so any client can connect. | |||||
| - `ssl.key`: //Optional string.// If you want to use SSL on this port, | |||||
| the path to an SSL key. | |||||
| - `ssl.cert`: //Optional string.// If you want to use SSL on this port, | |||||
| the path to an SSL certificate. | |||||
| The defaults are appropriate for simple cases, but you may need to adjust them | |||||
| if you are running a more complex configuration. | |||||
| Configuring Phabricator | |||||
| ======================= | |||||
| You may also want to adjust these settings: | You may also want to adjust these settings: | ||||
| - `notification.client-uri` Externally-facing host and port that browsers will | - `notification.client-uri` Externally-facing host and port that browsers will | ||||
| connect to in order to listen for notifications. | connect to in order to listen for notifications. | ||||
| - `notification.server-uri` Internally-facing host and port that Phabricator | - `notification.server-uri` Internally-facing host and port that Phabricator | ||||
| will connect to in order to publish notifications. | will connect to in order to publish notifications. | ||||
| - `notification.log` Log file location for the server. | - `notification.log` Log file location for the server. | ||||
| ▲ Show 20 Lines • Show All 88 Lines • Show Last 20 Lines | |||||