Differential D15702 Diff 37845 src/docs/user/configuration/notifications.diviner

Changeset View

Standalone View

src/docs/user/configuration/notifications.diviner

	Show First 20 Lines • Show All 69 Lines • ▼ Show 20 Lines
	To make adjustments to the default configuration, either copy this file to			To make adjustments to the default configuration, either copy this file to
	create `aphlict.custom.json` in the same directory (this file will be used if			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:			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`: 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.
				- `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 localhost (so only other services on the			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			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.

				Each log in the `logs` list should be an object with these keys:

				- `path`: //Required string.// Path to the log file.

	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
	=======================			=======================

	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.pidfile` Pidfile location used to stop any running server when
	aphlict is restarted.


	Verifying Server Status			Verifying Server Status
	=======================			=======================

	Access `/notification/status/` to verify the server is operational. You should			Access `/notification/status/` to verify the server is operational. You should
	see a table showing stats like "uptime" and connection/message counts if the			see a table showing stats like "uptime" and connection/message counts if the
	server is working. If it isn't working, you should see an error.			server is working. If it isn't working, you should see an error.
	▲ Show 20 Lines • Show All 78 Lines • Show Last 20 Lines