Installation Options

Simple installation

For a simple installation/upgrade of TinyPilot, see the instructions in the main README.

Advanced installation

To choose configuration options for the install, specify them in the TINYPILOT_INSTALL_VARS environment variable.

Possible variables are available in:

• TinyPilot settings
• uStreamer settings
• nginx settings

Example: custom resolution and release version

Here's an example that installs TinyPilot with a desired capture resolution of 1280x720 and chooses the 1.0.2 version of TinyPilot.

export TINYPILOT_INSTALL_VARS="ustreamer_resolution=1280x720 tinypilot_repo_branch=1.0.2"
curl \
  --silent \
  --show-error \
  https://raw.githubusercontent.com/mtlynch/tinypilot/master/quick-install | \
    bash - && \
  sudo reboot

Example: TC358743 HDMI to CSI capture chip

If you're using a Toshiba TC358743-based HDMI capture chip, the following installation options optimize performance with that chip:

export TINYPILOT_INSTALL_VARS="ustreamer_capture_device=tc358743"
curl \
  --silent \
  --show-error \
  https://raw.githubusercontent.com/mtlynch/tinypilot/master/quick-install | \
    bash - && \
  sudo reboot

• Note: The ustreamer_capture_device variable is special in that it's "sticky." It persists across installations unless you perform another install explicitly changing it.

Making installation options permanent

These settings apply to only the current shell session. If you'd like to apply these installation options on every update, add them to your .bashrc file:

echo 'export TINYPILOT_INSTALL_VARS="ustreamer_resolution=1280x720 tinypilot_repo_branch=1.0.2"' >> ~/.bashrc
. ~/.bashrc

Developer installation

If you're interested in contributing to TinyPilot, follow these instructions to install the required developer packages in your development environment:

python3.7 -m venv venv && \
  . venv/bin/activate && \
  pip install --requirement requirements.txt && \
  pip install --requirement dev_requirements.txt && \
  npm install [email protected]

To run TinyPilot's build scripts, run:

./dev-scripts/build

To enable TinyPilot's Git hooks, run:

./hooks/enable_hooks

To run TinyPilot on a non-Pi machine, run:

./dev-scripts/serve-dev

Use proxy

This procedures shows how to install TinyPilot using proxy.

1. get quick-install script.

export http_proxy=http://<proxy server address>:<proxy port>/
# if you use proxy which requires login:
# export http_proxy=http://<user id>:<password>@<proxy server address>:<proxy port>/
export https_proxy=${http_proxy}
wget --no-check-certificate https://raw.githubusercontent.com/mtlynch/tinypilot/master/quick-install

2. Edit quick-install and save as quick-install-proxy

sed -e 's/sudo apt-get/sudo -E apt/' quick-install > quick-install-proxy
sed -i -e 's/pip install/pip --trusted-host pypi.org --trusted-host files.pythonhosted.org install/' quick-install-proxy
sed -i -e 's/ansible-galaxy install --/ansible-galaxy install --ignore-cert --/' quick-install-proxy

3. run quick-install-proxy

export TINYPILOT_INSTALL_VARS="tinypilot_pip_args='--trusted-host pypi.org --trusted-host files.pythonhosted.org'"
bash quick-install-proxy && sudo reboot