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.
 
 
 
 
 
Michael Lynch 9befcc1bdd
Rename licensing module to license_notice (#978)
1 week ago
.circleci Setup unit tests for the frontend (#772) 9 months ago
.dependabot Add checks for whitespace consistency (#405) 1 year ago
.github Automatically merge from Community -> Pro (#839) 6 months ago
.vscode Configure VS Code to auto-format code with YAPF (#707) 1 year ago
app Rename licensing module to license_notice (#978) 1 week ago
dev-scripts Use standardized `check-bash` script (#974) 3 weeks ago
e2e Add ShellCheck to Circle CI config. (#569) 1 year ago
hooks Add checks for whitespace consistency (#405) 1 year ago
readme-assets Update Voyager 2 image in README (#955) 2 months ago
scripts Provide custom methods for logging sensitive data (#830) 6 months ago
.gitignore Load keyboard and mouse paths from Flask config file (#754) 9 months ago
.prettierignore Adding frontend checks to build and CI (#127) 2 years ago
.pylintrc Adjust pylint rules to allow URLs longer than the column limit (#841) 6 months ago
.shellcheckrc Add ShellCheck to Circle CI config. (#569) 1 year ago
.style.yapf Configure VS Code to auto-format code with YAPF (#707) 1 year ago
.yapfignore Configure VS Code to auto-format code with YAPF (#707) 1 year ago
ARCHITECTURE.md Update URL for ansible-role-tinypilot (#719) 12 months ago
CONTRIBUTING.md Add element naming conventions to CONTRIBUTING.md. (#895) 4 months ago
COPYRIGHT Initial commit 2 years ago
LICENSE Add an About page (#976) 1 week ago
MANIFEST.in add setup.py for Python packaging (#94) 2 years ago
README.md Update Voyager 2 image in README (#955) 2 months ago
__init__.py Initial commit 2 years ago
dev_app_settings.cfg Janus/WebRTC frontend (#943) 2 months ago
dev_requirements.txt Upgrade pyflakes to 2.4.0 (#843) 6 months ago
package.json Setup unit tests for the frontend (#772) 9 months ago
quick-install Rename licensing module to license_notice (#978) 1 week ago
requirements.txt Rename licensing module to license_notice (#978) 1 week ago
setup.py Update URLs for new TinyPilot org (#724) 12 months 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 2

Photo of TinyPilot Voyager 2

Voyager 2 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 Stretch or later
  • 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/quick-install | \
    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:

/opt/tinypilot/dev-scripts/dump-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.