diff --git a/README.md b/README.md index 04c99f1..f815118 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,60 @@ -# peach-vps config +# peach-vps -Scripts for configuring the peachcloud vps for various hosting and automation. +![Generic badge](https://img.shields.io/badge/version-0.2.0-.svg) + +Scripts for configuring the PeachCloud VPS for various hosting and automation functions. Currently: -- debian repository of microservices +- Debian repository of microservices +# Setup Debian repo + +An idempotent script for initializing the Debian repo on the VPS -# setup debian repo -an idempotent script for initializing the debian repo on the vps ``` apt update 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 scripts/setup_debian_repo.py and set the following constants: +# USER_PATH, GPG_KEY_EMAIL, GPG_KEY_PASS_FILE python3 scripts/setup_debian_repo.py -i ``` +# Update Debian repo + +Without the -i flag, the `setup_debian_repo` script rebuilds all +microservices (cross-compiled to arm64) and updates the Debian repo -# update debian repo -without the -i flag, the setup_debian_repo rebuilds all -microservices (cross-compiled to arm64) and re-adds them to the debian repo ``` cd peach-vps python3 scripts/setup_debian_repo.py ``` +# Using the Debian repo + +To add the PeachCloud Debian repo as an apt source, run the following commands from your Pi: -# using the debian repo on the pi -To add the peachcloud debian repo as an apt source, -on the pi, ``` vi /etc/apt/sources.list.d/peach.list ``` + and add the following line: + ``` deb http://apt.peachcloud.org/debian/ buster main ``` Then add the gpg pub key to the apt-key list: + ``` wget -O - http://apt.peachcloud.org/peach_pub.gpg | sudo apt-key add - ``` You can then install peach packages with apt-get: + ``` apt-get update apt-get install peach-oled -``` \ No newline at end of file +```