Commit 4640a28d authored by Jakob Moser's avatar Jakob Moser
Browse files

Add README with basic setup instructions

parent 1882f1aa
Loading
Loading
Loading
Loading

README.md

0 → 100644
+24 −0
Original line number Diff line number Diff line
# PoolPay

Maintainer: Jakob Moser <moser@cl.uni-heidelberg.de>

## Setup

### Raspberry Pi

1. Use the official “Raspberry Pi Imager” to flash an SD card
   * Use “Raspberry Pi OS” (the one recommended)
   * Use custom OS settings:
     * Hostname `poolpaypi`(`.local`)
     * Username `jakob`
     * Password: Auto-generate a safe one
     * Don't setup WiFi
     * Timezone: Europe/Berlin
     * Keyboard layout: de
     * Enable SSH auth via public-key, generate a keypair manually
     * Disable telemetry
2. Insert the SD card into the Pi and boot it up
3. On your main computer, use Network Manager (GUI or [CLI](https://ubuntu.com/core/docs/networkmanager/configure-shared-connections)) to enable a “Shared Ethernet” connection
4. Use an ethernet cable to connect the Pi to your main computer
     * Your computer should immediately start acting as a “wired hotspot” now and provide IP address and internet access to the Pi.
5. You can now `ssh jakob@poolpaypi.local` on your main computer and it shoud Just Work™.