Skip to content

Latest commit

 

History

History
87 lines (57 loc) · 3.06 KB

INSTALL.md

File metadata and controls

87 lines (57 loc) · 3.06 KB
Raw

petfeedd Installation

No matter which installation path you choose, the first step is to install Raspbian and configure to your liking.

Quickstart using Docker

If you just want to run petfeedd and don't want to go to all of the work below to run it from source, I maintain Docker images that are complete and ready for immediate use. To install this way:

  1. Install Docker on your Raspberry Pi. You may need to log out and back in if you get permission errors.

  2. docker pull peckrob/petfeedd. Be patient, it will take a bit.

  3. sudo touch /opt/petfeedd.db && sudo chown pi: /opt/petfeedd.db

  4. docker run --privileged -v /opt/petfeedd.db:/opt/petfeedd.db -p 0.0.0.0:8080:8080 peckrob/petfeedd

Navigate to the IP of your Raspberry Pi on port 8080, and you should see petfeedd running. It takes a bit to start, so give it about 20-30 seconds to get going. It will run with the defaults, but in order for it to be useful, you'll need to configure it.

The reason we pass --privileged to the container is to allow the container to access the host's GPIO pins. The reason that we pass -v /opt/petfeedd.db:/opt/petfeedd.db is to store the DB outside the container.

Different Architectures

The Docker image peckrob/petfeedd supports multiple architectures. The following architectures are currently supported.

  • arm64v8 - Raspberry Pi 4
  • arm32v7 - Raspberry Pi 2/2B/3/3B
  • arm32v6 - Raspperry Pi/Zero/Zero 2
  • amd64 - Intel x86

Unofficially, the underlying alpine base image also supports i386, ppc64le and s390x. These are not supported directly by petfeedd, but I know of no reason why they wouldn't work. If anyone needs support for these architectures (and can either provide test hardware or be a guinea pig) I can build for these arches too.

Building from Source

Note: I highly discourage you from building from source unless you know what you are doing. These instructions are mostly intended for people who want to contribute to petfeedd. If you just want to use petfeedd, Docker is definitely the way to go. The only other reason you might want to do this is if you are using an old or underpowered device (like a Pi Zero or a first-generation Raspberry Pi) and cannot spare the resources to run Docker.

  1. apt-get install -y git pigpio libpigpio1

  2. curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash - && sudo apt-get install -y nodejs

  3. cd /opt

  4. git clone git@github.com:peckrob/petfeedd.git

  5. cd petfeedd

  6. npm install

  7. npx webpack

  8. useradd -d /opt/petfeedd -G gpio petfeedd

  9. cp init/systemd/petfeedd.service /etc/systemd/system

  10. touch /opt/petfeedd.db

  11. chown -R petfeedd: /opt/petfeedd*

  12. systemctl daemon-reload

  13. systemctl start petfeedd

Updating

Simply docker pull peckrob/petfeedd and restart the container. Or, if installed from source, git pull from the checkout and restart petfeedd using systemctl.