Skip to content

Commit 9752ae4

Browse files
committed
Update readme.
1 parent fc61b7e commit 9752ae4

File tree

3 files changed

+18
-2
lines changed

3 files changed

+18
-2
lines changed
106 KB
Loading
88.3 KB
Loading

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,31 @@
33
A zero-trust remote control solution built with .NET 8, MAUI, and SignalR.
44

55
[![Build Status](https://dev.azure.com/translucency/ControlR/_apis/build/status%2FControlR?branchName=main)](https://dev.azure.com/translucency/ControlR/_build/latest?definitionId=35&branchName=main)
6-
76
[![Discord](https://img.shields.io/discord/1245426111903699087?label=Discord&logo=discord&logoColor=white&color=7289DA)](https://discord.gg/JWJmMPc72H)
87

98
Website: https://controlr.app
109
Docker: https://hub.docker.com/r/translucency/controlr
1110
Feature Requests: https://features.controlr.app/
1211
Discussions: https://github.com/bitbound/ControlR/discussions
1312

13+
Microsoft Store: https://www.microsoft.com/store/productId/9NS914B8GR04
14+
Play Store: https://play.google.com/apps/testing/dev.jaredg.controlr.viewer
15+
1416
## Testers Needed:
1517

1618
Please join the [Android Beta Test](https://play.google.com/apps/testing/dev.jaredg.controlr.viewer) if you can. I need at least 20 users to stay in the program for at least 14 days before I can publish the app to the Play Store.
1719

1820
## Quick Start:
1921

20-
Steps:
22+
Public Server:
23+
24+
- Install the Viewer through the Microsoft Store or Play Store.
25+
- In the Viewer app, create a new keypair by clicking the Create button.
26+
- Install the agent on a computer by copying and pasting one of the scripts on the Deploy page.
27+
- You should now see the computer in the devices list and be able to remote control it.
28+
- Note: Remote control is only supported for agents running on Windows.
29+
30+
Self-Hosted:
2131

2232
- Run Docker with the example compose file (see below).
2333
- Download and install the viewer from `http[s]://{host_name}/downloads/ControlR.Viewer.{msix/apk}`.
@@ -57,6 +67,12 @@ If you're using the public server at app.controlr.app, you can use either instal
5767

5868
You can see which method the app is currently using on the `About` page, next to `Install Source`.
5969

70+
## Screenshots
71+
72+
![Windows Sessions on Desktop](.assets/screenshots/desktop_windows-sessions.png)
73+
74+
![Windows Sessions on Android](.assets/screenshots/mobile_windows-sessions.jpg)
75+
6076
## How the Zero-Trust Works
6177

6278
Zero-trust is implemented via RSA public/private keypairs. When the agent is installed, you supply the public keys that are allowed to access the device.

0 commit comments

Comments
 (0)