Skip to content
Branch: master
Find file Copy path
Find file Copy path
1 contributor

Users who have contributed to this file

211 lines (182 sloc) 11.5 KB


Build Status

A remote control and remote scripting solution, built with .NET Core and SignalR Core.

Public Server: (not intended for production use)

Build Instructions (Windows 10)

The following steps will configure your Windows 10 machine for building the Remotely server and clients.

  • Install Visual Studio 2019.
  • Install the latest .NET Core SDK.
  • Clone the git repository and open the solution in Visual Studio.
  • Build (in Release configuration) the Remotely_Desktop and Remotely_ScreenCast projects.
    • By default, the screen-sharing desktop app prompts for a host URL and can be changed thereafter. To hard-code a URL, set the ForceHost value in /Remotely_Desktop/ViewModels/MainWindowViewModel.cs to the server's URL.
  • Run Publish.ps1 in the Utilities folder.
    • Example: powershell -f [path]\Publish.ps1 -outdir C:\inetpub\remotely -rid win10-x86
    • The output folder will now contain the server, with the clients in the Downloads folder.

Hosting a Server (Windows)

  • Create a site in IIS that will run Remotely.
  • Run Install-RemotelyServer.ps1 (as an administrator), which is in the Utilities folder in source control.
  • Download and install the .NET Core Runtime (not the SDK).
    • Link:
    • This includes the Hosting Bundle for Windows, which allows you to run ASP.NET Core in IIS.
    • Important: If you installed .NET Core Runtime before installing all the required IIS features (which is done in the script), you may need to run a repair on the .NET Core Runtime installation.
  • Change values in appsettings.json for your environment.
  • If using SQLite configuration, make sure the ApplicationPool's account has write access to the DB file location.
    • The script will do this for you, assuming all default settings.
  • After creating your account on the website, you can set "AllowSelfRegistration" to false in appsettings.json to disable registration.
  • If the site will be public-facing, configure your bindings in IIS.
  • An SSL certificate for HTTPS is recommended. You can install one for free using Let's Encrypt.
  • Documentation for hosting in IIS can be found here:

Hosting a Server (Ubuntu)

  • Currently, only Ubuntu 18.04 is tested. The Linux server package will likely work with other distros after some alterations to the setup script.
  • Run (with sudo), which is in the Utilities folder in source control.
    • This script is only for Ubuntu 18.04.
    • The script installs the .NET Core runtime, as well as other dependencies.
    • Certbot is used in this script and will install an SSL certificate for your site. Your server needs to have a public domain name that is accessible from the internet for this to work.
    • App root will be the above output folder.
  • Change values in appsettings.json for your environment.
  • After creating your account on the website, you can set "AllowSelfRegistration" to false in appsettings.json to disable registration.
  • Documentation for hosting behind Nginx can be found here:


  • On clients, logs are kept in %temp%\Remotely_Logs.txt.
    • For the Agent running as a Windows service, this maps to C:\Windows\Temp\Remotely_Logs.txt.
  • On the server, some event information is explicitly written to the EventLogs table in the database.
  • Built-in ASP.NET Core logs are written to the console (stdout). You can redirect this to a file if desired.
    • In IIS, this can be done in the web.config file by setting stdoutLogEnabled to true.
  • On Windows Servers, the above logs can also be written to the Windows Event Log.
    • This is enabled in appsettings.json by setting EnableWindowsEventLog to true.
  • You can configure logging levels and other settings in appsetttings.json.

Remote Control Requirements

  • Windows: Only the latest version of Windows 10 is tested.
    • Requires .NET Framework 4.7.2.
    • Windows 2016/2019 should work as well, but isn't tested regularly.
  • Linux: Only Lubuntu 18.10 is tested.
    • Your account must be set to auto login for unattended remote control to work.

Session Recording

  • You can turn on session recording in appsettings.json.
  • The following requirements must be met for it to work:
    • On Linux, libgdiplus and libc6-dev must be installed (sudo apt-get install libgdiplus libc6-dev).
    • The process running the app must have access to create and modify a folder name "Recordings" in the site's root content folder.
    • FFmpeg must be executable from the process running the Remotely server.
  • Remote control sessions will first be recorded as a series of images, which will then be converted to MP4 using FFmpeg.

Remote Control on Mobile

Ideally, you'd be doing remote control from an actual computer or laptop. However, I've tried to make the remote control at least somewhat usable from a mobile device. Here are the controls:

  • Left-click: Single tap
  • Right-click: Double tap
  • Click-and-drag: Tap and hold with one finger, tap and release a second finger (without pinch-zooming)
    • The click-and-drag operation will begin where finger one is held.

Shortcut Keys

There are a few shortcut keys available when using the console.

  • / : Slash will open the autocomplete for selecting the current command mode. The names are configurable in the Account - Options page.
  • Up/Down: Use arrow up/down to cycle through input history.
  • Ctrl + Up/Down: Scroll the console output window.
  • Ctrl + Q: Clear the output window.
  • Esc: Close the autocomplete window.


The following settings are available in appsettings.json.

  • DefaultPrompt: The default prompt string you'll see for each line on the console.

  • DBProvider: Determines which of the three connection strings (at the top) will be used. The appropriate DB provider for the database type is automatically loaded in code.

  • AllowSelfRegistration: Enable/disable the ability for people to create accounts.

  • RecordRemoteControlSessions: Whether or not to record remote control sessions.

  • RedirectToHTTPS: Whether ASP.NET Core will redirect all traffic from HTTP to HTTPS. This is independent of Nginx and IIS configurations that do the same.

  • UseHSTS: Whether ASP.NET Core will use HTTP Strict Transport Security.

  • DataRetentionInDays: How long event logs and remote command logs will be kept.

  • RemoteControlSessionLimit: How many concurrent remote control sessions are allowed per organization.

  • AllowApiLogin: Whether to allow logging in via the API (see below).

  • TrustedCorsOrigins: For cross-origin API requests via JavaScript. The websites listed in this array with be allowed to make requests to the API. This does not grant authentication, which is still required on most endpoints.

  • Smpt*: SMTP settings for auto-generated system emails (such as registration and password reset).

API and Integrations

Remotely has a basic API, which can be browsed at (or your own server instance). Most endpoints require authentication via the /api/Login, which in turn requires the AllowApiLogin option to be set to true in appsettings.json. If you're not familiar with how CORS works, I recommend reading up on it before proceeding.

Once AllowApiLogin is set to true, you'll be able to use the API with languages such as C# and PowerShell. For JavaScript clients to work, you'll also need to add the website's origin to the TrustedCorsOrigins array. For example, if I wanted to create a login form on that logged into the Remotely API, I'd need to add "" to the TrustedCorsOrigins.

Below are examples of how to use the API for starting a remote control session.

JavaScript Client

// Log in with one request, then launch remote control with another.
fetch("https://localhost:44351/api/Login/", {
	method: "post",
	credentials: "include",
	mode: "cors",
	body: '{"Email":"", "Password":"P@ssword1"}',
	headers: {
		"Content-Type": "application/json",
	if (response.ok) {
		fetch("https://localhost:44351/api/RemoteControl/Maker", {
			method: "get",
			credentials: "include",
			mode: "cors"
			if (response.ok) {

// Log in and launch remote control in the same request.
fetch("https://localhost:44351/api/RemoteControl/", {
	method: "post",
	credentials: "include",
	mode: "cors",
	body: '{"Email":"", "Password":"P@ssword1", "DeviceName":"Maker"}',
	headers: {
		"Content-Type": "application/json",
	if (response.ok) {

C# Client

private static async Task StartRemoteControl()
	var client = new System.Net.Http.HttpClient();
	client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));

	var stringContent = new System.Net.Http.StringContent(
			'Email': '',
			'Password': 'P@ssword1'

	var response = await client.PostAsync("https://localhost:44351/api/Login", stringContent);
	if (response.IsSuccessStatusCode)
		response = await client.GetAsync("https://localhost:44351/api/RemoteControl/Maker");
		if (response.IsSuccessStatusCode)
			var remoteControlURL = await response.Content.ReadAsStringAsync();

PowerShell Client

$WebSession = New-Object Microsoft.PowerShell.Commands.WebRequestSession
$Response = Invoke-WebRequest -Uri "https://localhost:44351/api/Login" -WebSession $WebSession -Method Post -Body "
	'Email': '',
	'Password': 'P@ssword1'
" -ContentType "application/json"

if ($Response.StatusCode -eq 200) {
	$Response = Invoke-WebRequest -Uri "https://localhost:44351/api/RemoteControl/Maker" -WebSession $WebSession -Method Get -ContentType "application/json"
	if ($Response.StatusCode -eq 200) {
		Start-Process -FilePath $Response.Content

.NET Core Deployments

  • .NET Core has two methods of deployment: framework-dependent and self-contained.
    • Framework-dependent deployments require the .NET Core runtime to be installed on the target computers. It must be the same version or higher that was used to build the app.
    • Self-contained deployments include a copy of the runtime, so you don't need to install it on the target computers. As a result, the total file size is much larger.
  • .NET Core uses runtime identifiers that are targeted when building.
You can’t perform that action at this time.