https://github.com/akoidan/http-remote-pc-control
Allows to remotely control a computer using http api
https://github.com/akoidan/http-remote-pc-control
Last synced: about 2 months ago
JSON representation
Allows to remotely control a computer using http api
- Host: GitHub
- URL: https://github.com/akoidan/http-remote-pc-control
- Owner: akoidan
- Created: 2025-03-09T12:51:23.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-03-09T13:13:01.000Z (about 2 months ago)
- Last Synced: 2025-03-09T14:18:19.500Z (about 2 months ago)
- Language: C++
- Size: 660 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Http Remote PC control
Allows to remotely control this PC using http api. Events like:
- Mouse move, click
- Keyboard events
- Running executabe files or killing executable
- Operating windows, like focus, resize
You can also use https://github.com/akoidan/hotkey-hub for doing this via system wide keyboard shortcut from a remote PC.
## Get started
### Certificates
The client server app both use [mutual TLS authentication](https://www.cloudflare.com/learning/access-management/what-is-mutual-tls/).
You can use my helper script to generate certificates with [gen-cert.sh](./gen-cert.sh).
```bash
bash ./gen-cert.sh
```
It will generate:
- self-sign CA certificate with its private key and put CA cert into both ./certs/ca-cert.pem and ./client/ca-cert.pem
- server and client private key in the ./certs/key.pem and ./client/key.pem
- server and client certificate that are signed with CA private key and put it into ./certs/cert.pem and ./client/cert.pem
Leave certs directory in the project or within the same directory you are running app executable file.
Copy client directory to the remote PC where you have the [server](https://github.com/akoidan/hotkey-hub)
### Download the app
Here are instructions for windows, for linux you can just ignore windows specific intructions.
- Download client you want to receive shorcuts [releases](https://github.com/akoidan/http-remote-pc-control/releases).
- If windows antivirus deletes a file, you can allow it in **Virus & threat protection** -> **Protection History** -> Expaned recently blocked threat and allow it
- Ensure directory with the executalbe, or project direcotry contains `certs` directory with certificates
- Run exe files as Administrator.
- If windows antivirus complains about security Open **Virus & threat protection** -> **Virus & threat protection settings** -> **Exclusions Add or remove exclusions** -> **Add an exclusion**.
- If it crashes , open powershell and run exe file from it, it's a CLI app.
### Api documentation
You can find api documentation under [releases](https://github.com/akoidan/http-remote-pc-control/releases). You can put this file into any swagger ui, e.g. [Swagger Editor](https://editor.swagger.io/). This file can be generated locally with
```bash
yarn schema:swagger
```
This will create ./swagger.json in the project directory.
### NAT
If your current PC doesn't have a static IP or under NAT, you can use VPN or some 3rd party service like [ngrok](https://ngrok.com/) [localtunel](https://github.com/localtunnel/localtunnel) or [cloudflared](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/) to expose it to the world. Example with ngrock:
```bash
ngrok http 5000
```
### Custom port
By default app is listening port 5000, in order to change the port specify it as a first argument on the app executable. Example
```bash
./app.exe 5001
```
In order to change port on [server](https://github.com/akoidan/hotkey-hub) app, specify it as clientPort its config.jsonc
### Autostart on Windows OS
This program has to be started as Admin so it has permision to send keystrokes or move mouse. Add a script to autostart in Windows with admin petrmissions: Replace path to your app.exe:
```shell
@echo off
setlocal
:: Replace with the path to your program
set "ProgramPath=C:\Users\msi\Downloads\app.exe"
set "ProgramName=L2"
:: Create the task in Task Scheduler for admin startup
schtasks /create /tn "%ProgramName%" /tr "\"%ProgramPath%\"" /sc onlogon /rl highest /f
if %errorlevel% equ 0 (
echo Program added to startup with admin permissions successfully.
) else (
echo Failed to add program to startup.
)
pause
```
## Develop locally
### Requirements:
You need cmake, yarn, node version 18 or nvm, and a proper C/C++ compiler toolchain of the given platform
#### Windows
- [Visual C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/). If you installed nodejs with the installer, you can install these when prompted.
- An alternate way is to install the [Chocolatey package manager](https://chocolatey.org/install), and run `choco install visualstudio2017-workload-vctools` in an Administrator Powershell
- If you have multiple versions installed, you can select a specific version with `npm config set msvs_version 2017` (Note: this will also affect `node-gyp`)
- [cmake](https://cmake.org/download/),
- Node version 18 or [nvm](https://github.com/nvm-sh/nvm)
- [yarn](https://yarnpkg.com/).
#### Unix/Posix
- Clang or GCC
- Ninja or Make (Ninja will be picked if both present)
- Node version 18 or [nvm](https://github.com/nvm-sh/nvm)
- [yarn](https://yarnpkg.com/).
#### MacOS
- brew install cmake nvm yarn
#### ArchLinux:
- sudo pacman -S xcb-util-wm nvm yarn cmake g++
### Run in dev mode
To build the client you need
```sh
nvm use 18 # If you already have node 18, skip it
yarn # install depenencies
yarn build:local # builds native c++ modules
yarn start # starts a nestjs server
```
### Clion
If you want to debug native code, you need to build native module in a debug mode, `yarn build:local` already does it. Then you can attach to the nodejs process via gdb from Clion which should pull sourcemaps and allow to put breakpoints in native code. In order to start the process, you can still use `yarn start`, as soon as native module loads it will pull the breakpoints from IDE.
In order to have proper syntax highlight from nodejs headers, you have to manually add them to Clion configs:
Open Settings -> Cmake -> Add configuration
Add Cmake options:
```
-DCMAKE_CXX_FLAGS="-I/home/andrew/.nvm/versions/node/v18.18.2/include/node -I/home/andrew/it/my-projects/http-remote-pc-control/node_modules/node-addon-api"
```
Replace **/home/andrew/** to your home directory. Do not use `~` alias, should be absolute path.