Use your Raspberry Pi as a browser-based KVM.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
jotaen4tinypilot a0a21115a5
Document dev workflows for testing on device (#1414)
13 hours ago
.circleci Set up TinyPilot virtual environment from Debian package (#1352) 2 days ago
.dependabot Add checks for whitespace consistency (#405) 2 years ago
.github Clarify wording around syncing Community to Pro (#1324) 3 months ago
.vscode Fix recommended VS code extensions (#1104) 9 months ago
ansible-role Set up TinyPilot virtual environment from Debian package (#1352) 2 days ago
app Add ESLint rule to prevent parameter reassignment (#1399) 3 weeks ago
bundler Set up TinyPilot virtual environment from Debian package (#1352) 2 days ago
debian-pkg Set up TinyPilot virtual environment from Debian package (#1352) 2 days ago
dev-scripts Set up TinyPilot virtual environment from Debian package (#1352) 2 days ago
hooks Update comment for set -e to match our new conventions (#1384) 4 weeks ago
readme-assets Replace Voyager 2 with Voyager 2a in README (#1334) 2 months ago
scripts Fall back to installing from disk when device has insufficient memory (#1406) 1 week ago
.dockerignore Add a README.md to explain the tinypilot-privileged directory (#1421) 2 days ago
.eslintrc.cjs Add ESLint rule to prevent parameter reassignment (#1399) 3 weeks ago
.gitignore Add `package-lock.json` to source control (#1393) 3 weeks ago
.lintianignore Set up TinyPilot virtual environment from Debian package (#1352) 2 days ago
.prettierignore Use Prettier to format all non-Python files (#1041) 11 months ago
.pylintrc Use f-strings in places pylint recommends (#1143) 8 months ago
.shellcheckrc Add ShellCheck to Circle CI config. (#569) 2 years ago
.style.yapf Configure VS Code to auto-format code with YAPF (#707) 2 years ago
.yapfignore Configure VS Code to auto-format code with YAPF (#707) 2 years ago
ARCHITECTURE.md Create bundle using local `ansible-role` directory. (#1286) 4 months ago
CONTRIBUTING.md Document dev workflows for testing on device (#1414) 13 hours ago
COPYRIGHT Update COPYRIGHT (#1401) 2 weeks ago
LICENSE Add an About page (#976) 1 year ago
MANIFEST.in add setup.py for Python packaging (#94) 3 years ago
README.md Declare Bullseye as the minimum supported version (#1358) 2 months ago
__init__.py Initial commit 3 years ago
dev_app_settings.cfg Remove unused dev env variable. (#1202) 7 months ago
dev_requirements.txt Lint SQL scripts with sqlfluff (#1161) 7 months ago
get-tinypilot.sh Fall back to installing from disk when device has insufficient memory (#1406) 1 week ago
package-lock.json Bump nanoid and mocha (#1394) 3 weeks ago
package.json Bump nanoid and mocha (#1394) 3 weeks ago
quick-install Update overhaul community release. (#1046) 9 months ago
requirements.txt Upgrade to greenlet 1.1.3 (#1132) 8 months ago
setup.py Update URLs for new TinyPilot org (#724) 2 years ago

README.md

TinyPilot

License Contributors CircleCI Reddit Twitter

Overview

Turn your Raspberry Pi into a browser-based KVM.

TinyPilot demo

https://tinypilotkvm.com

Features

  • Video capture (HDMI/DVI/VGA)
  • Keyboard forwarding
  • Mouse forwarding
  • Fullscreen mode
  • Paste text from clipboard

Official builds

TinyPilot official hardware packages give you everything you need to run TinyPilot and allows you to fund TinyPilot's development for future improvements.

TinyPilot Voyager 2a

Photo of TinyPilot Voyager 2a

Voyager 2a is TinyPilot's professional-grade KVM over IP device. Its quiet, compact design makes it a great fit for professional environments such as offices, data centers, and server rooms.

Build your own

See "TinyPilot: Build a KVM Over IP for Under $100" for a more detailed tutorial on how to assemble these parts to create a TinyPilot.

Pre-requisites

  • Raspberry Pi OS Bullseye (32-bit)
  • python3-venv

Simple installation

You can install TinyPilot on a compatible Raspberry Pi in just two commands.

curl \
  --silent \
  --show-error \
  https://raw.githubusercontent.com/tiny-pilot/tinypilot/master/get-tinypilot.sh | \
    bash - && \
  sudo reboot

The installation process:

  • Creates a service account for TinyPilot with limited priviliges.
  • Installs TinyPilot as a systemd service so it runs automatically on every boot.
  • Installs and configures TinyPilot's dependencies:
    • nginx, which listens on 0.0.0.0:80
    • uStreamer, which listens on 127.0.0.1:8001
  • Installs TinyPilot to the /opt/tinypilot directory.

When your Pi reboots, you should be able to access TinyPilot by visiting your Pi hostname in the browser. For example, if your device is named raspberrypi:

Developer installation

See the CONTRIBUTING file.

Other installation options

Updates

To update to the latest version of TinyPilot, run the update script:

/opt/tinypilot/scripts/upgrade && sudo reboot

Diagnostics

If you're having trouble with TinyPilot, you can retrive logs from the web dashboard by clicking "Logs" in the bottom of the main dashboard.

If you can't access the web dashboard, you can retrieve the logs by SSHing into the device and running the following command:

sudo /opt/tinypilot-privileged/scripts/collect-debug-logs

This log is useful if you file a bug report.

You can read more details about the logs in the wiki.

Security considerations

TinyPilot does not support authentication or transport-level encryption. You should only use TinyPilot on networks that you trust. Anyone who accesses the TinyPilot URL can shutdown or restart your Pi and type arbitrary commands into the device to which your Pi is connected.

To use TinyPilot on untrusted networks, you can upgrade to TinyPilot Pro, which adds password-based authentication and TLS for end-to-end encryption.

As a free alternative, you can adjust your Nginx configuration (included by default with the installation) to require HTTP Basic Authentication and add a self-signed TLS certificate.

Detailed project updates

If you're interested in seeing what's happening with the project at a granular level, weekly updates appear every Friday on What Got Done:

See also

Acknowledgments

TinyPilot would not be possible without the excellent and generous work from many open source projects, the most notable of which are listed below:

Mailing list

For news about major TinyPilot releases and other updates about the project, sign up for the TinyPilot mailing list:

Upgrade to Pro

TinyPilot Pro includes additional features for professional users, including:

Support the project and upgrade to Pro at https://tinypilotkvm.com/product/tinypilot-pro.