EdgeRDP

KO | EN

gitlite — search

#react #ai #llm #golang #android #rust #deep-learning #linux #docker #macos #java #windows #vue #ios

(★ 60)

Provide native RDP solutions for internal network machines

EdgeRDP 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# EdgeRDP

[中文](README_CN.md) | English

EdgeRDP is a lightweight Gateway for Windows Remote Desktop. A controlled Windows machine keeps an outbound connection to the Gateway, and the controlling side can use the built-in Windows Remote Desktop client (`mstsc.exe`) from any Windows PC. No software is required on the controlling PC.

Typical address:

```text
office-pc.desk.example.com
```

## Start With The Client

The client runs on the Windows machine that will be controlled. A regular user only needs to enter three values:

```yaml
server_domain: "desk.example.com"
subdomain: "office-pc"
password: "device credential generated by the server"
```

`server_domain` can point to your own self-hosted Gateway or to a Gateway operated by someone else. `subdomain` identifies this controlled machine, and `password` is generated in the server admin UI.

After the client is online, any Windows PC can open `mstsc.exe` and connect to:

```text
office-pc.desk.example.com
```

Log in with the Windows username and password on the controlled machine. The controlling PC does not need EdgeRDP installed.

> Remote Desktop must be enabled on the controlled Windows machine, and the Windows login account must have a password.

## Then The Server

The server provides the proxy tunnel for controlled machines and a Web admin panel. It has two main services:

- Control API: admin UI, device credentials, online status, Agent login, and client updates.
- RDP Router: listens on the public RDP port and routes connections by device subdomain.

In practice, the server is a self-hostable RDP Gateway. One Gateway can serve many controlled Windows machines, so you can run it for yourself, for a team, or for customer devices.

If you are using a Gateway provided by a third party, the client-side configuration above is usually sufficient. Continue with the following sections if you plan to deploy your own server.

## Before Self-Hosting

Prepare an Ubuntu 22.04/24.04 server and a domain such as `desk.example.com`. DNS must point both `desk.example.com` and `*.desk.example.com` to the server. Open `3389/tcp` for RDP Router, `4389/tcp` for Agent tunnels, and `4390/tcp` for the fastest HTTP deployment. If you enable HTTPS, also open `80/tcp` and `443/tcp`. If the server is in Mainland China, complete the required ICP filing before exposing the domain publicly.

## Fastest Deployment: HTTP, No HTTPS

Use this path to get the system running first. It assumes DNS is ready, the ports are free, and HTTPS is not enabled yet.

Install baseline dependencies:

```bash
sudo apt update
sudo apt install -y git curl ca-certificates build-essential
```

Source deployment also needs Go 1.26+, Node.js 22+, and npm. If your Ubuntu apt repository provides sufficiently new packages, you can install `golang-go nodejs npm`; otherwise install newer Go and Node.js from their official sources first.

Then run:

```bash
git clone https://github.com/inklife/EdgeRDP.git
cd EdgeRDP
sudo bash server/scripts/deploy-all.sh --server-domain desk.example.com
```

The script builds the admin UI, Control API, and RDP Router, then installs them under `/opt/edgerdp/`. Default HTTP deployment:

```text
Admin UI: http://desk.example.com:4390
Agent Tunnel: desk.example.com:4389
RDP entry: <subdomain>.desk.example.com
Default account: admin / admin
```

After first login, change the admin password and create a device. The admin UI will generate the device `subdomain` and credential. Give those values plus `server_domain` to the controlled Windows client.

Useful checks:

```bash
sudo systemctl status edgerdp-api
sudo systemctl status edgerdp-router
sudo journalctl -u edgerdp-api -f
sudo journalctl -u edgerdp-router -f
```

## Enable HTTPS

HTTPS is recommended for real use. The simplest option is to let the deployment script install and configure Caddy:

```bash
cd EdgeRDP
sudo bash server/scripts/deploy-all.sh --server-domain desk.example.com --https true
```

Control API will listen on `127.0.0.1:4390`, and the public admin URL becomes:

```text
https://desk.example.com
```

Caddy config:

```caddyfile
desk.example.com {
    reverse_proxy 127.0.0.1:4390
}
```

Nginx reference:

```nginx
server {
    listen 443 ssl;
    server_name desk.example.com;

ssl_certificate /path/to/fullchain.pem;
    ssl_certificate_key /path/to/privkey.pem;

location / {
        proxy_pass http://127.0.0.1:4390;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
}
```

If you configure the reverse proxy yourself, keep `/opt/edgerdp/control-api/config.yaml` aligned:

```yaml
web:
  listen_host: "127.0.0.1"
  listen_port: 4390
  public_scheme: "https"

https:
  enabled: true
```

Restart:

```bash
sudo systemctl restart edgerdp-api
sudo systemctl restart edgerdp-router
sudo systemctl reload caddy    # or sudo systemctl reload nginx
```

RDP Router and Agent Tunnel do not go through the HTTP reverse proxy. Keep `3389/tcp` and `4389/tcp` open directly.

## More Docs

- [Chinese detailed guide](docs/detailed-guide-cn.md)
- [English detailed guide](docs/detailed-guide.md): full configuration fields, ports, troubleshooting, and backups.

## Development

```bash
cd server/control-api
go test ./...

cd ../rdp-router-go
go test ./...
```

```powershell
cd client\gui
.\build.ps1
```

EdgeRDP

EdgeRDP 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

EdgeRDP

EdgeRDP 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README