Skip to content

Install instructions

Jump to bottom
Davy Keppens edited this page May 17, 2019 · 80 revisions

Welcome to the PieHelper Wiki!

Important :

  • This guide assumes the hardware installation of the RaspBerry is already done and that an OS supported by PieHelper is already installed on the SD card

    • If not, guides for performing both of these tasks first, can be found online
    • For more information on supported Operating Systems for PieHelper, please check the 'README.md' file

  • Italic print represents commands to type on the command line

        -> To do so from another networked system, use an application such as 'ssh' 
     ('putty' if on a Windows system) to connect
        OR
    -> If local on the RaspBerry, just launch a terminal application for that

  • location should always be replaced with the pathname (the full directory path) where you want to install PieHelper.

  • user should always be replaced with the account you want to use to run PieHelper

    • This account can be 'root' or any other account with full sudo rights

    • The account preconfigured by default on the system normally always has full sudo rights

      -> For Ubuntu, Noobs and Raspbian distros that account is : 'pi'
    OR
-> For Archlinux : 'alarm'

    • For more information on 'sudo' : man sudo

  • Keep in mind that no matter whether Piehelper itself or any other tool is used to configure the OS, keyboard layout may be different from what you're used to as long it hasn't been configured properly first, using the tool of your choice

  • If you plan to use PieHelper to also configure the OS, you'll need to know the following information before you start :

    • The name of the locale you want to use on the system
    • The name of the timezone identifier you want to use on the system
    • The name of the keyboard layout you want to use on the system
    • The hostname you want to use for the system

How to install :

  • If you have sudo rights : sudo bash

    OR

    If you are root : Skip this step

  • For Ubuntu, Noobs and Raspbian distros : apt-get install git

    OR

    For ArchLinux : pacman -S git

  • su - user (Skip this step if you want to run PieHelper as 'root')

  • cd location

  • git clone https://github.com/dkeppens/PieHelper.git

    (A subdirectory called 'PieHelper' containing everything will be automatically created)

How to configure :

  • If you have sudo rights : sudo bash

    OR

    If you are root : skip this step

  • cd location/PieHelper/scripts

  • If you have already configured the OS using other tools (i.e. raspi-config,...) or are planning to do so :

    • For Ubuntu, Noobs and Raspbian distros : apt-get install ksh

      OR

      For Archlinux : pacman -S ksh

    • su - user (Skip this step if you want to run PieHelper as 'root')

    • cd location/PieHelper/scripts

    • ./confpieh_ph.sh -c

      (The system will reboot into the PieHelper menu after initial configuration ends)

      (That's it. You're done !)

    OR

  • If you want to use PieHelper to configure the OS and keep using the PI's default user account :

    • ./confoper_ph.sh -p all -i

      (When prompted for which user to create, enter the system's default user (see info about default users in the 'Important' section above))

      (The system will reboot after OS configuration ends)

    • login as user when the system is back online

    • cd location/PieHelper/scripts

    • ./confpieh_ph.sh -c

      (The system will reboot into the PieHelper menu after initial configuration ends)

      (That's it. You're done !)

    OR

  • If you want to use PieHelper to configure the OS and want to replace the PI's default user account with a new one :

    • ./confoper_ph.sh -p user -i

      (When prompted, enter the new user account you wish to create)

    • logout OR exit OR init 6

    • login as the newly created user account when the login prompt appears

    • sudo bash

    • cd location/PieHelper/scripts

    • ./confoper_ph.sh -p all -i

      (When prompted again for which user to create, reenter the same account you just created or create a second one if desired)

      (The system will reboot after OS configuration ends)

    • login as user when the system is back online

    • cd location/PieHelper/scripts

    • ./confpieh_ph.sh -c

      (The system will reboot into the PieHelper menu after initial configuration ends)

      (That's it. You're done !)

Additional remarks :

  • You can always run/rerun from any to all OS configuration functions again at a later time from either :

    • The PieHelper menu

      OR

    • By running location/PieHelper/scripts/confoper_ph.sh [parameters] as 'root' from the command line

  • location/PieHelper/scripts/confoper_ph.sh to get an overview of all parameters available for 'confoper_ph.sh'

Clone this wiki locally