Each Device contains one or more Services.
The ability to use the Desktop application to directly manage Services on a Device depends on which package you have installed.
- If you have installed the Desktop Application itself and wish to add Services to the local Device.
- If your Device is running the remoteit Device Package version 4.0 or later.
- If your Device is using remoteit Device Package version 3.0.2 or earlier, you can manage Services using the Web Admin Panel in a browser, or by using the Command Line Interface in a console window.
- If your device is using any version of the connectd package, you will have to connect via console (i.e. SSH or monitor/keyboard) and run the connectd_installer script.
To start, click on the highlighted "+" icon:
Now you can enter the Service Type, the name you wish to give to this Service, the port it will use (Service Port), and the Service Host Address.
For applications which are running on the current device, leave the Service Host Address at 127.0.0.1.
For applications which are running on another device on the same LAN, set the Service Host Address to the IP address or mdns address (e.g. raspberrypi.local) of that other device.
Note that if no application is detected, you will get a warning message as shown. In this example, the node-red server is actually running on a different device on the same LAN. The port value also had to be changed to 1880 to match the settings of the node-red application.
At the moment, Desktop is unable to correctly identify UDP based services.
Once everything is correct, you will see the green confirmation message as shown.
Note that the Service detection only works for TCP based applications.
Click on a Service name in the center panel, then click on the "Details" button to open the Service Details view.
- Last reported - how long ago the most recent heartbeat message was received by remote.it's servers. You may need to click on the "refresh" icon at upper left to get an accurate value.
Port is the port value to use with the Bind IP address.
Service Name - the full name of the remote Service that you are currently connected to. In the case of Services which were registered individually using the remoteit CLI, the full name appends the Service Name to the Device Name.
- Remote port - the port of the application on the target device.
- Remote protocol - TCP or UDP
- Service Type - the Service Type you specified when registering this Service.
- Service ID - this is a unique identifier for each service in your account. This is set at the time you register each service. Also known as the "Service ID" or "UID".
- License - shows the License status of this Service.
Clicking on the "Edit" button opens up a view into the editable parameters for this connection. Note that some of the available options depend on what type of connection it is.
After editing any of the options, click on the blue "Save" button near the bottom to save your changes.
- Service Type - the application associated with this Service, e.g. SSH, VNC, Minecraft, http.
- Service Name - the name of the Service.
Service Port - the port which the server application on your device is actually using. For example, SSH typically uses port 22. See: Plan what you want to connect to
- Service Host address: the host address that you will use in your client application to make the remote connection, along with the port value which is generated when you Add the Service to your Network.
- Enable Service - whether or not this Service should be enabled by default. This setting only works if the target device uses the remoteit "Device Package".
Routing - one of the following connection modes. Peer to peer connections generally have better performance than proxy connections but may not work in all situations. The default "peer to peer with proxy failover" is the default and should work for most situations. Connections which use UDP have to use peer to peer mode. Learn more about the differences here: Peer to Peer vs Proxy Connections.
- Peer to peer with proxy failover - initially attempts a peer to peer connection. If that fails, uses proxy connection instead.
- Peer to peer only
- Proxy only.
The launch URL Template - a configurable string that lets you format the command line for launching the Service to your needs via the browser. This requires support in your browser, which works better on macOS than Windows for some applications.
Copy command template - used when you use the "Copy Launch String" method. Generally speaking you will use this when you wish to use the remoteit Connection IP address/URL and port in something other than the default application for this Service Type.
To delete or unregister a Service, make sure that "Edit Service" is selected, then click on the trashcan icon as shown. This function only works if the target device uses the remoteit "Device Package", or is the local device (that is, the Services are on the Device where you are running the Desktop application).
You'll see this confirmation message. Click on OK to delete the Service, or Cancel if you've changed your mind.
To share a single Service on a Device, or a selected group of Services, select the Service, then click on the highlighted icon at upper right.
Enter the e-mail of the remote.it account you wish to share to. You can also select other Services here if you like. Finally, you can also choose whether to allow the other account to execute bulk scripts on this Device (applies only to Linux targets). When you've made all the entries to your satisfaction, click on "Save".
Deleting sharing from a Shared Service
Click on the "Shared Users" button to show all users to whom you have shared the current Service.
Click on the name of the user for which you wish to remove sharing for this Service, then click on the trashcan icon.
After a few moments the sharing will be removed. The Service itself is not removed from your account.
Learn more about Sharing here.