⚠️ This repo is no longer active and has been archived. The active repo can be found at https://git.coopcloud.tech/PeachCloud/peach-workspace/src/branch/main/peach-config ⚠️

---

peach-config

Python module which handles installation and updating for PeachCloud.

Installation From PeachCloud Disc Image

The recommended way to install PeachCloud is to download the latest PeachCloud disc image from http://releases.peachcloud.org, and flash it to an SD card. peach-config is included as part of this disc image, and can then be used as a tool for updating PeachCloud as needed.

You can find detailed instructions on setting up PeachCloud from a PeachCloud disc image here.

Installation From Debian Disc Image

You can find a guide for installing plain Debian onto a Raspberry pi here.

Once you have Debian running on your pi, you can install peach-config by adding the PeachCloud apt repository and using apt.

To add the PeachCloud Debian package archive as an apt source, run the following commands from your Pi:

echo "deb http://apt.peachcloud.org/ buster main" > /etc/apt/sources.list.d/peach.list
wget -O - http://apt.peachcloud.org/pubkey.gpg | sudo apt-key add -

You can then install peach-config with apt:

sudo apt-get update
sudo apt-get install python3-peach-config

peach-config has only been tested on a Raspberry Pi 3 B+ running Debian 10.

Usage

The peach-config debian module installs a command-line tool to /usr/bin/peach-config.

peach-config is a tool for installing PeachCloud and for updating it.

peach-config -h shows the help menu:

usage: peach-config [-h] {setup,manifest,update} ...

positional arguments:
  {setup,manifest,update}
    setup               idempotent setup of PeachCloud
    manifest            prints manifest of peach configurations
    update              updates all PeachCloud microservices

optional arguments:
  -h, --help            show this help message and exit

The setup command takes a few different parameters to customize configuration.

usage: peach-config setup [-h] [-i] [-n] [-d] [-r {ds1307,ds3231}] user

positional arguments:
  user                  username for the default user account

optional arguments:
  -h, --help            show this help message and exit
  -i, --i2c             configure i2c
  -n, --noinput         run setup without user input
  -d, --defaultlocale   set default locale to en_US.UTF-8 for compatability
  -r {ds1307,ds3231}, --rtc {ds1307,ds3231}
                        configure real-time clock

A <USER> argument must be supplied to create a new system user. You will be prompted to enter a password for your newly created user.

The script also allows optional configuration of I2C and real-time clock (RTC) modules. I2C configuration is necessary for the OLED display and physical interface to work correctly. RTC configuration is required for the real-time clock to work correctly. When passing the -r flag, the type of real-time clock module must be included (either ds1307 or ds3231). Selecting real-time clock configuration will not work if the I2C flag is not selected (in other words, the real-time clock requires I2C).

Run the script as follows for a full installation and configuration with I2C and the ds3231 RTC module (username in this case is peach):

peach-config setup -i -r ds3231 peach

Licensing

AGPL-3.0