conf/templates | ||
peach_package_builder | ||
.gitignore | ||
README.md | ||
requirements.txt |
peach-package-builder
Scripts for building debian packages for PeachCloud microservices.
Setup Build Environment
python3 peach_package_builder/setup_build_env.py
An idempotent script for initializing a build and deployment environment for PeachCloud packages.
The script currently performs the following actions:
- Installs system requirements
- Creates directories for microservices and package archive
- Installs Rust
- Installs
cargo deb
- Installs Rust aarch64 toolchain for cross-compilation
- Installs Freight for package archive creation and management
- Configures Freight
- Pulls microservices code from GitHub repos
- Exports the public GPG key
- Configures nginx
The script can also be run with the optional -u
flag (--update
) to update the Rust compiler and installed toolchains.
NB: Prior to executing the script for the first time, run the following commands on the target system:
sudo apt update
sudo apt install git python python3-pip rsync
git clone https://github.com/peachcloud/peach-vps.git
cd peach-vps
pip3 install -r requirements.txt
Open peach_package_builder/setup_build_env.py
and set the following constants:
- USER_PATH
- GPG_KEY_EMAIL
- GPG_KEY_PASS_FILE
Then execute the script to run the full system initialization process (note: several commands executed by the script require sudo
permissions. You will be prompted for the user password during the execution of the scipt.):
python3 -u peach_package_builder/setup_build_env.py
Build packages
peach_package_builder/build_packages.py
An idempotent script for building the latest versions of all PeachCloud packages and adding them to the Debian package archive.
The script currently performs the following actions:
- Builds and updates Rust microservice packages
- Builds and updates peach-config python package
- Adds packages to Freight library
- Adds packages to Freight cache
python3 peach_package_builder/build_packages.py -d
The -d flag ensures that all packages are built from the latest version of the default branch currently on GitHub. Without the -d flag, whatever version of the code is locally stored will be used (which can be useful for testing).
Freight supports the ability to have multiple versions of a package in a single Debian package archive. If a particular version of a package already exists in the Freight library, it will not be readded or overwritten.
You can also just build a single package by running (e.g. peach-web, peach-config, etc.):
python3 peach_package_builder/build_packages.py -d -p package-name
Build peach-go-sbot package
First, open peach_package_builder/build_peach_go_sbot.py and manually edit PEACH_GO_SBOT_VERSION.
We manually increment the version number when we want to build a new version of peach-go-sbot.
Then run,
python3 peach_package_builder/build_peach_go_sbot.py
This builds the peach-go-sbot package using the latest code from go-ssb, along with a systemd unit file, and adds the Debian package to the Freight library.
Install Packages from Debian Package Archive
To add the PeachCloud Debian package archive as an apt source, run the following commands from your Pi:
vi /etc/apt/sources.list.d/peach.list
Append the following line:
deb http://apt.peachcloud.org/ buster main
Add the gpg pub key to the apt-key list:
wget -O - http://apt.peachcloud.org/pubkey.gpg | sudo apt-key add -
You can then install peach packages with apt:
sudo apt update
sudo apt install peach-oled
By default, the latest version of the package will be downloaded and installed.
Specific versions of packages can be selected for installation by supplying the semantic versioning number (this is useful for downgrading):
sudo apt install peach-network=0.2.0
Licensing
AGPL-3.0