Remotely | remote control and remote scripting solution | Frontend Framework library

Before attempting installation, verify that your domain name is resolving to your server's IP address. For example, I can use the command ping remotely.lucency.co and see the IP address to which it resolves.
Find and download the Remotely_Server_Installer[.exe] CLI tool for the latest release on the Releases page. You will run it on the server where you'll be hosting Remotely. You need to run it with elevation (e.g. sudo or "Run as admin"). Use --help argument to see all the command line arguments. If values are provided for all arguments, it will run non-interactive. You can choose between installing the pre-built release package, or entering GitHub credentials to build and install a customized server. The pre-built package will not have your server's URL embedded in the clients. End users will need to enter it manually.
If you want to use the pre-built package, run the installer now, and you're done! Otherwise, follow the below steps for setting up the GitHub Actions integration, then run the installer afterward.
Fork the repo if you haven't already. If you've already forked the repo and haven't updated your fork recently, you'll need to do so first. You can use the following commands to pull the latest changes, merge them, and push them back up to your repo (git required). Make sure to replace {your-username} with your GitHub username. This example assumes you've added your SSH key to your GitHub account. git clone git@github.com:{your-username}/remotely cd ./remotely git remote add upstream https://github.com/lucent-sea/remotely git pull upstream master git push origin master
Go to the Actions tab in your forked repo and make sure you can see the Build workflows. Before you can use Actions for the first time, there will be prompt that you must accept on this page.
Create a Personal Access Token that the installer will use to authorize with GitHub. Located here: https://github.com/settings/tokens It needs to have the repo scope. Save the PAT when it's displayed. It will only be shown once.
By default, the server will be built from the author's repo. If you want to build from your fork, comment out the repository line in Build.yml (in your repo). There's a comment in the file that points out the line.
Now run the installer, as described above.
In the site's content directory, make a copy of the appsettings.json file and name it appsettings.Production.json. The server will use this new file for reading/writing its settings, and it won't be overwritten by future ugprades.
If using Caddy, a TLS cert will be installed automatically. When installling on Nginx, the script will use Certbot and prompt you to install a cert. For Windows IIS, you'll need to use a separate program that integrates with Let's Encrypt. Resources: https://letsencrypt.org/docs/client-options/#clients-windows-/-iis
By default, SQLite is used for the database. The "Remotely.db" database file is automatically created in the root folder of your site. You can browse and modify the contents using DB Browser for SQLite.
Create your account by clicking the Register button on the main page. This account will be both the server admin and organization admin. An organization is automatically created for the account. Organizations are used to group together users, devices, and other data items into a single pool. By default, only one organization can exist on a server. The Register button will disappear. People will no longer be able to create accounts on their own. To allow self-registration, increase the MaxOrganizationCount or set it to -1 (see Configuration section).
The following steps will configure your Windows 10 machine for building the Remotely server and clients.
Install Visual Studio 2019. Link: https://visualstudio.microsoft.com/downloads/ You should have the following Workloads selected: ASP.NET and web development .NET desktop development .NET Core cross-platform development You should have the following Individual Components selected: .NET SDK (latest version). MSBuild (which auto-selects Roslyn compilers). NuGet targets and build tasks. .NET Framework 4.8 SDK. For debugging and development, you'll need all relevant workloads.
Install Git for Windows. Link: https://git-scm.com/downloads
Install the latest LTS Node: Link: https://nodejs.org/
Clone the git repository: git clone https://github.com/lucent-sea/remotely
When debugging, the agent will use a pre-defined device ID and connect to https://localhost:5001.
In development environment, the server will assign all connecting agents to the first organization.
The above two allow you to debug the agent and server together, and see your device in the list.