Skip to content

dasl-/pifi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pifi

Setting up from Scratch

Compatible hardware

  • Raspberry Pi 4 - this is our recommended pi model. At least 2 GB of RAM is recommended.

  • Raspberry Pi 3B+

  • Although it will likely work on a Raspberry Pi 5, this is untested and not officially supported.

Install Raspian Lite

  1. Use the official Raspberry Pi Imager to write the disk image to your SD card

  2. Operating System > Raspberry Pi OS (other) > Raspberry Pi OS Lite (64-bit), Debian Trixie. Installation of other OS versions is not officialy supported.

  3. OS customisation settings:

    1. General

      1. Username: pi

      2. Set wifi credentials

    2. Services

      1. Enable SSH

  4. Write OS to SD card and eject SD card

Setup Raspberry Pi

  1. Connect via ssh: ssh [email protected]

  2. sudo apt-get update

  3. sudo apt-get upgrade -y

  4. sudo apt-get install git

Setup Git

  1. ssh-keygen -t rsa -b 4096 -C “[email protected]

  2. eval "$(ssh-agent -s)"

  3. ssh-add ~/.ssh/id_rsa

  4. more ~/.ssh/id_rsa.pub (copy to git)

  5. https://help.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account

  6. https://github.com/settings/keys

Checkout Repo

  1. git clone [email protected]:dasl-/pifi.git

  2. cd pifi

Install

  1. Create a config file: config.json. The config file should set all of the required config parameters.

  2. ./install/install_dependencies.sh

  3. ./install/install.sh

    1. This may result in an out of memory error. If that happens, simply re-run the install script. It should succeed the second time.

  4. Set your youtube API key

  5. optional reboot to confirm services come up automatically and cleanly from a reboot: sudo shutdown -r now

Vanity domain name (optional):

  • By default, raspberry pi’s have the hostname raspberrypi. As such, you can SSH onto the pi or hit the pifi webpage via raspberrypi.local (i.e.: ssh [email protected] and http://raspberrypi.local

  • The ./install/install.sh script has an argument you can use to change the hostname, e.g. ./install/install.sh -g pifi

  • You can optionally reserve an IP address for the pifi on your router (if it supports this)

  • Note if you choose 192.168.1.166 for the reserved IP, then the domain name http://pifi.club/ will resolve to your pi on your wifi network :)

    • FreshTomato router firmware has a setting Enable DNS Rebind protection, which is enabled by default. When this is enabled, it will prevent upstream DNS servers from resolving queries to any non-routable IP (e.g., 192.168.1.X). So you need to disable this feature for the vanity URL to work.

Connect GPIO Pins

  • power: 2

  • ground: 6

  • data: 19

  • clock: 23

Hacking on the code:

Issues we’ve seen before

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5