deskreen README

The project's README from github.com/pavlobu/deskreen. As one markdown file: README.md.

Deskreen CE (Community Edition)

platform (Over 2M downloads during 5 years since launch)

Deskreen Logo

Deskreen turns any device with a web browser into a secondary screen for your computer

To learn more visit our website: deskreen.com

Donate to support Deskreen Open-Source

Deskreen is an electron.js based application that uses WebRTC to make a live stream of your computer screen to a web browser on any device. It is available for MacOS, Windows and Linux operating systems. The current open-source Community Edition version has limited features. If you need more features please consider upgrading to Pro version for more features when it is released.

▶️ See how people use Deskreen on Youtube (video tutorials, demos, use cases for Deskreen day to day usage)

Deskreen Frequently Asked Questions

Prerequisites

You will need to have node>=v23 npm>=10 installed.

  1. git clone this repo
  2. npm i
  3. cd ./src/client-viewer && npm i && cd ../..
  4. npm run clean && npm run build && npm run start -- run in prod like mode

for more npm scripts look at package.json

Starting with Custom Local IP

You can start Deskreen CE with a custom local IP address using the --local-ip or --ip CLI flag. This is useful when you want to specify a particular network interface IP address.

macOS

# Using open command (recommended)
open -a "Deskreen CE" --args --ip 192.168.1.100

# Or using the executable directly
/Applications/Deskreen\ CE.app/Contents/MacOS/Deskreen\ CE --ip 192.168.1.100

# Get your IP automatically and launch
open -a "Deskreen CE" --args --ip "192.168.1.100"

Windows

# Using Start-Process (PowerShell)
Start-Process "Deskreen CE" -ArgumentList "--ip", "192.168.1.100"

# Or using the executable directly
"C:\Program Files\Deskreen CE\Deskreen CE.exe" --ip 192.168.1.100

# Or from Command Prompt
start "" "C:\Program Files\Deskreen CE\Deskreen CE.exe" --ip 192.168.1.100

Linux

# If installed via AppImage
./Deskreen\ CE-*.AppImage --ip 192.168.1.100

# If installed via .deb/.rpm package (usually in /usr/bin or /opt)
deskreen-ce --ip 192.168.1.100

# Or using full path
/opt/Deskreen\ CE/deskreen-ce --ip 192.168.1.100

Note: Replace 192.168.1.100 with your actual local IP address. You can find your IP using:

When using the --ip or --local-ip flag, the app will use the specified IP for QR codes and connection URLs, while still monitoring the actual network interface status for WiFi connection detection.

Maintainer

License

AGPL-3.0 License © Pavlo (Paul) Buidenkov

Electron-Vite MIT License © electron-vite

React MIT License © Facebook, Inc. and its affiliates

Vite MIT License © Vite.js

Electron Builder MIT License © electron-builder contributors

Apache 2.0 © blueprintjs

simple-peer MIT. Copyright © Feross Aboukhadijeh

tweetnacl ISC License © Dmitry Chestnykh, Devi Mandiri, and contributors (https://github.com/dchest/tweetnacl-js)

darkwire.io MIT License © darkwire/darkwire.io

And many many others...

Thanks

🙏 Many thanks to all 🌍 open source community members and maintainers of libraries used in this project.

deskreen (pavlobu/deskreen)

Searching Database…

21.6K ·GitHub
Deskreen
Что это такое?Deskreen превращает любое устройство с веб-браузером — телефон, планшет или ноутбук — во второй экран для вашего компьютера. Это приложение на Electron, которое в реальном времени транслирует экран вашего компьютера через WebRTC.
То есть Deskreen ставится только на компьютер, а на втором устройстве достаточно просто открыть браузер?Именно так. Приложение устанавливается только на компьютер; второму устройству не нужно ничего, кроме браузера — в нём открывается ссылка на подключение или сканируется QR-код, который показывает Deskreen.
Как мне её запустить?Для Community Edition нужно собрать проект из исходников: клонируйте репозиторий, выполните npm i, установите зависимости client-viewer, затем npm run clean && npm run build && npm run start. Сайт проекта — deskreen.com.
Что должно быть установлено перед сборкой?Node.js версии 23 или новее и npm версии 10 или новее. Всё остальное npm подтянет сам на этапах установки.
В бесплатной версии чего-то не хватает?Да — в открытой Community Edition возможности ограничены. В README для тех, кому нужно больше, рекомендуют готовящуюся Pro-версию, но она ещё не вышла, и список её функций не приводится.
Какие операционные системы поддерживаются?macOS, Windows и Linux. Для просмотра подходит любой веб-браузер, так что телефоны и планшеты работают независимо от их ОС.
Это проверенный инструмент или свежий эксперимент?Проверенный: за пять лет с момента выхода Community Edition скачали более 2 миллионов раз.
Можно разделять не весь рабочий стол, а только одно окно приложения?Да — среди тем проекта указаны и 'share-screen', и 'share-app-window', то есть трансляция отдельного окна доступна наряду с трансляцией всего экрана.
Поток между моим компьютером и вторым устройством шифруется?Судя по метаданным проекта, да: у него есть метка 'end-to-end-encryption', а в благодарностях упомянуты tweetnacl и darkwire.io — библиотеки, используемые для шифрования WebRTC.
На чём он сделан?TypeScript на Electron, сборка через electron-vite. Интерфейс — на React с Blueprint.js, WebRTC работает через simple-peer, а за шифрование отвечает tweetnacl.
What are similar projects?webtorrent-desktop, PeerTube, dashbeam, streambert, lolPing, ds-harness-remote, bitbang, WebRTC-Experiment
Which topics is it in?electronjs, end-to-end-encryption, wifi, qr-code, video-streaming, webrtc, p2p, vite, app, electron, agpl, streaming
Creator
pavlobu
Size
11 MB
Stars
21.6K
Updated
CommitJul 08Releasev3.2.16Jul 08
Age
6y
Commits · 90 Days