Changeset View
Changeset View
Standalone View
Standalone View
src/docs/user/configuration/notifications.diviner
| Show First 20 Lines • Show All 71 Lines • ▼ Show 20 Lines | |||||
| it exists) or specify a configuration file explicitly with the `--config` flag: | it exists) or specify a configuration file explicitly with the `--config` flag: | ||||
| phabricator/ $ bin/aphlict start --config path/to/config.json | phabricator/ $ bin/aphlict start --config path/to/config.json | ||||
| The configuration file has these settings: | The configuration file has these settings: | ||||
| - `servers`: //Required list.// A list of servers to start. | - `servers`: //Required list.// A list of servers to start. | ||||
| - `logs`: //Optional list.// A list of logs to write to. | - `logs`: //Optional list.// A list of logs to write to. | ||||
| - `cluster`: //Optional list.// A list of cluster peers. This is an advanced | |||||
| feature. | |||||
| - `pidfile`: //Required string.// Path to a PID file. | - `pidfile`: //Required string.// Path to a PID file. | ||||
| Each server in the `servers` list should be an object with these keys: | Each server in the `servers` list should be an object with these keys: | ||||
| - `type`: //Required string.// The type of server to start. Options are | - `type`: //Required string.// The type of server to start. Options are | ||||
| `admin` or `client`. Normally, you should run one of each. | `admin` or `client`. Normally, you should run one of each. | ||||
| - `port`: //Required int.// The port this server should listen on. | - `port`: //Required int.// The port this server should listen on. | ||||
| - `listen`: //Optional string.// Which interface to bind to. By default, | - `listen`: //Optional string.// Which interface to bind to. By default, | ||||
| the `admin` server is bound to `127.0.0.1` (so only other services on the | the `admin` server is bound to `127.0.0.1` (so only other services on the | ||||
| local machine can connect to it), while the `client` server is bound | local machine can connect to it), while the `client` server is bound | ||||
| to `0.0.0.0` (so any client can connect). | to `0.0.0.0` (so any client can connect). | ||||
| - `ssl.key`: //Optional string.// If you want to use SSL on this port, | - `ssl.key`: //Optional string.// If you want to use SSL on this port, | ||||
| the path to an SSL key. | the path to an SSL key. | ||||
| - `ssl.cert`: //Optional string.// If you want to use SSL on this port, | - `ssl.cert`: //Optional string.// If you want to use SSL on this port, | ||||
| the path to an SSL certificate. | the path to an SSL certificate. | ||||
| - `ssl.chain`: //Optional string.// If you have configured SSL on this | - `ssl.chain`: //Optional string.// If you have configured SSL on this | ||||
| port, an optional path to a certificate chain file. | port, an optional path to a certificate chain file. | ||||
| Each log in the `logs` list should be an object with these keys: | Each log in the `logs` list should be an object with these keys: | ||||
| - `path`: //Required string.// Path to the log file. | - `path`: //Required string.// Path to the log file. | ||||
| Each peer in the `cluster` list should be an object with these keys: | |||||
| - `host`: //Required string.// The peer host address. | |||||
| - `port`: //Required int.// The peer port. | |||||
| - `protocol`: //Required string.// The protocol to connect with, one of | |||||
| `"http"` or `"https"`. | |||||
| Cluster configuration is an advanced topic and can be omitted for most | |||||
| installs. For more information on how to configure a cluster, see | |||||
| @{article:Clustering Introduction} and @{article:Cluster: Notifications}. | |||||
| The defaults are appropriate for simple cases, but you may need to adjust them | The defaults are appropriate for simple cases, but you may need to adjust them | ||||
| if you are running a more complex configuration. | if you are running a more complex configuration. | ||||
| Configuring Phabricator | Configuring Phabricator | ||||
| ======================= | ======================= | ||||
| After starting the server, configure Phabricator to connect to it by adjusting | After starting the server, configure Phabricator to connect to it by adjusting | ||||
| `notification.servers`. This configuration option should have a list of servers | `notification.servers`. This configuration option should have a list of servers | ||||
| that Phabricator should interact with. | that Phabricator should interact with. | ||||
| Normally, you'll list one client server and one admin server, like this: | Normally, you'll list one client server and one admin server, like this: | ||||
| ▲ Show 20 Lines • Show All 151 Lines • Show Last 20 Lines | |||||