nuclide-server

Provides a collection of services that are run on the Nuclide server to support remote file editing.

This package runs as a Node package to provide the server-side functionality required by Nuclide to support remote file editing.

Nuclide Server Prerequisites

• Node v0.12.0 or greater. There are various installer and package options depending on your platform on the nodejs.org site.

• Watchman. The Nuclide server requires Watchman to detect file and directory changes. You can build and/or install Watchman for your server's platform as described here.

• SSH Daemon. The Nuclide client connects to the server via SSH, so ensure that the server exposes an SSH daemon that you can connect to from your client machine, and that you know the credentials required.

Installing Nuclide Server

Ensure that the Nuclide project is checked out onto the remote server. Run the following command from the root of the repository to install Nuclide's server dependencies:

./scripts/dev/setup --no-atom

Note that the --no-atom flag ensures that only Nuclide's Node packages are installed on the server, and not those used by the Atom client itself.

Running Nuclide Server

You do not need to explicitly start the server since the Nuclide client will attempt to do so when it first connects over SSH, as explained in Remote Projects README.

Troubleshooting

If you want to debug the server starting up, you can of course run the command directly:

./pkg/nuclide/server/nuclide-start-server

A successful start will display the port upon which the server has started, and a JSON dump of certificate information:

Nuclide started on port 9090.
{"workspace": null, "ca": "-----BEGIN CERTIFICATE-----\n...

The nuclide-start-server command also has a useful help option:

./pkg/nuclide/server/nuclide-start-server -h

This explains many of the other options available, such as timeout, workspace directory to use and so on.