https://github.com/guysoft/electricsheeppi
A Raspberry Pi distribution to to run Electric Sheep
https://github.com/guysoft/electricsheeppi
Last synced: 2 months ago
JSON representation
A Raspberry Pi distribution to to run Electric Sheep
- Host: GitHub
- URL: https://github.com/guysoft/electricsheeppi
- Owner: guysoft
- License: gpl-3.0
- Created: 2017-07-18T08:00:21.000Z (almost 8 years ago)
- Default Branch: devel
- Last Pushed: 2024-02-21T16:08:56.000Z (over 1 year ago)
- Last Synced: 2024-05-01T18:57:17.756Z (about 1 year ago)
- Language: Shell
- Size: 52.7 KB
- Stars: 38
- Watchers: 5
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
ElectricSheepPi
===============
.. image:: http://unofficialpi.org/media/electric_sheep_pi_image2.jpg
.. :scale: 100 %
.. :alt: Image of Electric Sheep
A `Raspberry Pi `_ distribution to to run `Electric Sheep : Crowdsourced Evolving Art `_ out of the box and the scripts necessary to load it at boot. This repository contains the source script to generate the distribution out of an existing `Raspbian `_ distro image. `You can download a built image here `_
ElectricSheepPi is based on `CustomPiOS `_
Donate
------
ElectricSheepPi is 100% free and open source and maintained by Guy Sheffer. If its helping your life, your organisation or makes you happy, please consider making a donation. It means I can code more and worry less about my balance. Any amount counts.
Also many thanks to people contributing code.
|paypal|
.. |paypal| image:: https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif
:target: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=26VJ9MSBH3V3W&source=url
Where to get it?
----------------
You can use the `pi-imager `_ commuity raspberrypi imager here, unofficial section.
Or download directly form the official mirror `here `_
How to use it?
--------------
#. Unzip the image and install it to an SD card `like any other Raspberry Pi image `_
#. Configure your WiFi by editing ``electricsheep-network.txt`` or ``electric-sheep-wpa-supplicant.txt`` on the root of the flashed card when using it like a flash drive
#. Boot the Pi from the SD card
#. If you have internet, Electric Sheep will start.
#. If needed Log into your Pi via SSH (it is located at ``electricsheep.local`` `if your computer supports bonjour `_ or the IP address assigned by your router), default username is "pi", default password is "raspberry", change the password using the ``passwd`` command and expand the filesystem of the SD card through the corresponding option when running ``sudo raspi-config``.
Requirements
------------
* Raspberrypi 1/2/3/4B and zero
* 2A power supply
* Internet connection
Features
--------
* Runs Electric Sheep out of the box
Developing
----------
Requirements
~~~~~~~~~~~~
#. `qemu-arm-static `_
#. `CustomPiOS `_
#. Downloaded `Raspbian `_ image.
#. root privileges for chroot
#. Bash
#. realpath
#. sudo (the script itself calls it, running as root without sudo won't work)
Build ElectricSheepPi From within Raspbian / Debian / Ubuntu
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ElectricSheepPi can be built from Debian, Ubuntu, Raspbian.
Build requires about 2.5 GB of free space available.
You can build it by issuing the following commands::
sudo apt-get install realpath p7zip-full qemu-user-static
git clone https://github.com/guysoft/CustomPiOS.git
git clone https://github.com/guysoft/ElectricSheepPi.git
cd ElectricSheepPi/src/image
wget -c --trust-server-names 'https://downloads.raspberrypi.org/raspbian_lite_latest'
cd ..
../../CustomPiOS/src/update-custompios-paths
sudo modprobe loop
sudo bash -x ./build_dist
Building ElectricSheepPi Variants
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ElectricSheepPi supports building variants, which are builds with changes from the main release build. An example and other variants are available in the folder ``src/variants/example``.
To build a variant use::
sudo bash -x ./build_dist [Variant]
Building Using Vagrant
~~~~~~~~~~~~~~~~~~~~~~
There is a vagrant machine configuration to let build ElectricSheepPi in case your build environment behaves differently. Unless you do extra configuration, vagrant must run as root to have nfs folder sync working.
To use it::
sudo apt-get install vagrant nfs-kernel-server
sudo vagrant plugin install vagrant-nfs_guest
sudo modprobe nfs
cd ElectricSheepPi/src/vagrant
sudo vagrant up
After provisioning the machine, its also possible to run a nightly build which updates from devel using::
cd ElectricSheepPi/src/vagrant
run_vagrant_build.sh
To build a variant on the machine simply run::
cd ElectricSheepPi/src/vagrant
run_vagrant_build.sh [Variant]
Usage
~~~~~
#. If needed, override existing config settings by creating a new file ``src/config.local``. You can override all settings found in ``src/config``. If you need to override the path to the Raspbian image to use for building OctoPi, override the path to be used in ``ZIP_IMG``. By default, the most recent file matching ``*-raspbian.zip`` found in ``src/image`` will be used.
#. Run ``src/build_dist`` as root.
#. The final image will be created in ``src/workspace``
Code contribution would be appreciated!