https://github.com/MirrorX-Desktop/MirrorX
Remote control tool for enterprise, teams and individuals. Build fast and security remote control network with fully control in a short time.
https://github.com/MirrorX-Desktop/MirrorX
remote-control remote-desktop rust tauri
Last synced: 7 months ago
JSON representation
Remote control tool for enterprise, teams and individuals. Build fast and security remote control network with fully control in a short time.
- Host: GitHub
- URL: https://github.com/MirrorX-Desktop/MirrorX
- Owner: MirrorX-Desktop
- License: gpl-3.0
- Created: 2022-03-09T17:51:16.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-16T09:46:15.000Z (over 2 years ago)
- Last Synced: 2024-10-15T03:41:06.353Z (12 months ago)
- Topics: remote-control, remote-desktop, rust, tauri
- Language: Rust
- Homepage: https://mirrorx.app
- Size: 60.1 MB
- Stars: 797
- Watchers: 10
- Forks: 49
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-ops - MirrorX-Desktop/MirrorX - 3.0|818|2022-03-09|2023-05-16 | 基于 Rust 构建的远程桌面控制软件 | (运维管理平台)
README
MirrorX
### **OPEN**
MirrorX is an open-source remote desktop solution, designed for enterprises, teams and individuals.
### **TRANSPARENCY**
Everything is under your control, allows you to deploy on-prem and/or in the Cloud, and also supports end-to-end encryption.
### **HIGH-PERFORMANCE**
GPU acceleration, 4K resolution, 60 FPS... make you feel like a "local desktop".
----
Features like video and audio pass-through, file transfer, cross-platform, mobile device support and so on are really essential, and more features are coming soon.
> **Note: MirrorX is in the early stage of development, please be aware that backward compatibility is not guaranteed.**
## Component
- [MirrorX Client](https://github.com/MirrorX-Desktop/MirrorX)
- [MirrorX Portal Server](https://github.com/MirrorX-Desktop/portal)
- [MirrorX Relay Server](https://github.com/MirrorX-Desktop/relay)
## Free Public Servers
> The servers are provided by the community, please do not abuse them.
| Location | Specification |
| :------: | :------------: |
| Seoul | 1vCPU & 1G RAM |
## Available Platforms
- [x] macOS
- [x] Windows
- [ ] Linux (WIP)
- [ ] Android (WIP)
- [ ] iOS (WIP)
- [ ] Web (WIP)
## How to build
### Prerequisites
1. Install `nodejs && yarn(v3)`.
2. Install `tauri-cli`.
```console
cargo install tauri-cli
```
### Steps
1. Download pre-built media libraries artifacts from [MirrorX-Desktop/media_libraries_auto_build](https://github.com/MirrorX-Desktop/media_libraries_auto_build) Release.
2. Unzip artifacts to anywhere you'd like to put in.
3. **Add unzipped artifacts path to your Environment Variables**
- For MacOS
```console
$ export MIRRORX_MEDIA_LIBS_PATH=your artifacts unzip destination path
```
- For Windows **(run As Administrator)**
```PowerShell
PS > [Environment]::SetEnvironmentVariable('MIRRORX_MEDIA_LIBS_PATH', 'your artifacts unzip destination path' , 'Machine')
```
4. Run as Debug Mode
```console
cargo tauri dev
```
## About Pre-built Media Libraries
To speed up the build process, we made [MirrorX-Desktop/media_libraries_auto_build](https://github.com/MirrorX-Desktop/media_libraries_auto_build) to automatically and transparently build external libraries. Includes [FFmpeg](https://git.ffmpeg.org/ffmpeg.git), libx264([Windows](https://github.com/ShiftMediaProject/x264.git), [MacOS](https://code.videolan.org/videolan/x264.git)), libx265([Windows](https://github.com/ShiftMediaProject/x265.git), [MacOS](https://bitbucket.org/multicoreware/x265_git.git)), libopus([Windows](https://github.com/ShiftMediaProject/opus.git), [MacOS](https://github.com/xiph/opus.git)) and MFXDispatch([Windows](https://github.com/ShiftMediaProject/mfx_dispatch.git) only). For more details, you can look through [Workflows](https://github.com/MirrorX-Desktop/media_libraries_auto_build/tree/main/.github/workflows) on [MirrorX-Desktop/media_libraries_auto_build](https://github.com/MirrorX-Desktop/media_libraries_auto_build).
Of course, you can completely built those libraries by yourself according to our [Workflows](https://github.com/MirrorX-Desktop/media_libraries_auto_build/tree/main/.github/workflows).
## Screenshots
## Thanks
### Thanks to these awesome open source projects that make MirrorX becomes true.
(listed partial with in no particular order, thanks all the authors of dependencies in Cargo.toml and package.json)
1. [Rust](https://github.com/rust-lang/rust)
2. [Tokio](https://github.com/tokio-rs/tokio)
3. [FFMPEG](https://ffmpeg.org)
4. [serde](https://github.com/serde-rs/serde)
5. [ring](https://github.com/briansmith/ring)
6. [egui](https://github.com/emilk/egui)
7. [windows-rs](https://github.com/microsoft/windows-rs)
8. [sveltekit](https://github.com/sveltejs/kit)
9. [daisyUI](https://github.com/saadeghi/daisyui)
10. [tailwindcss](https://github.com/tailwindlabs/tailwindcss)
11. [ShiftMediaProject](https://github.com/ShiftMediaProject)