I forgot that TinyPilot Pro already has a file called licensing.py that serves a different purpose.
|1 week ago|
|.circleci||9 months ago|
|.dependabot||1 year ago|
|.github||6 months ago|
|.vscode||1 year ago|
|app||1 week ago|
|dev-scripts||3 weeks ago|
|e2e||1 year ago|
|hooks||1 year ago|
|readme-assets||2 months ago|
|scripts||6 months ago|
|.gitignore||9 months ago|
|.prettierignore||2 years ago|
|.pylintrc||6 months ago|
|.shellcheckrc||1 year ago|
|.style.yapf||1 year ago|
|.yapfignore||1 year ago|
|ARCHITECTURE.md||12 months ago|
|CONTRIBUTING.md||4 months ago|
|COPYRIGHT||2 years ago|
|LICENSE||1 week ago|
|MANIFEST.in||2 years ago|
|README.md||2 months ago|
|__init__.py||2 years ago|
|dev_app_settings.cfg||2 months ago|
|dev_requirements.txt||6 months ago|
|package.json||9 months ago|
|quick-install||1 week ago|
|requirements.txt||1 week ago|
|setup.py||12 months ago|
Turn your Raspberry Pi into a browser-based KVM.
- Video capture (HDMI/DVI/VGA)
- Keyboard forwarding
- Mouse forwarding
- Fullscreen mode
- Paste text from clipboard
TinyPilot official hardware packages give you everything you need to run TinyPilot and allows you to fund TinyPilot's development for future improvements.
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
- Raspberry Pi 4 (all variants work)
- HDMI to USB dongle
- In smaller form factor
- They have no brand name, and there are several variants, but they're all built on the same MacroSilicon 2109 chip.
- They're available for $10-15 on eBay and AliExpress.
- 3 Amp power supply
- USB-C to USB-A cable (Male/Male)
- microSD card (Class 10, 8 GB or larger)
- HDMI to HDMI cable
- Or [other] to HDMI, depending on how your target machine displays output.
- (Optional) A USB-C OTG split connector: Supports continuous power when the target computer turns off.
- (Optional) VGA to HDMI Adapter
- If your target computer has VGA output, the above adapter is confirmed to work with TinyPilot.
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.
- Raspberry Pi OS Stretch or later
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
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
See the CONTRIBUTING file.
Other installation options
To update to the latest version of TinyPilot, run the update script:
/opt/tinypilot/scripts/upgrade && sudo reboot
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:
This log is useful if you file a bug report.
You can read more details about the logs in the wiki.
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:
- TinyPilot Wiki: Guides for tasks related to TinyPilot.
- TinyPilot Ansible Role: Use Ansible to install TinyPilot and all dependencies as a systemd service.
TinyPilot would not be possible without the excellent and generous work from many open source projects, the most notable of which are listed below:
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:
- Virtual drive mounting and booting
- Password-based authentication
Support the project and upgrade to Pro at https://tinypilotkvm.com/product/tinypilot-pro.