Skip to content

README.md

Latest commit

 

History

History
77 lines (53 loc) · 2.48 KB

README.md

File metadata and controls

77 lines (53 loc) · 2.48 KB
Raw

rasp-personal

Personal scripts for raspberry pi

Docker Setup

Run make setup-docker to install Docker, Docker Compose, and add your user to the docker group. Note: You may need to logout and login again (or reboot) after installation for group permissions to apply.

Note: You may need to logout and login again (or reboot) after installation for group permissions to apply.

Rasp Bridge (Apple Home Integration)

Run make setup-rasp-bridge to install and start the Python API bridge. This API allows you to control the VPN via simple HTTP requests, suitable for Apple Shortcuts.

Endpoints:

  • GET /vpn/status: Check VPN status.
  • GET /vpn/on: Turn VPN on.
  • GET /vpn/off: Turn VPN off.

VPN Router config

  1. sudo nano /etc/openvpn/client/clearvpn.conf
  2. Copy config from clearvpn
  3. Edit line with auth-user-pass and change it to: 
    auth-user-pass /etc/openvpn/client/clearvpn-pass.txt
  4. sudo nano /etc/openvpn/client/clearvpn-pass.txt
  5. Add your credentials

Aliases

Run make setup-vpn-aliases to add the following aliases to your .bashrc:

  • vpn-start: Start the VPN connection.
  • vpn-stop: Stop the VPN connection.
  • vpn-status: Check the VPN connection status.

Pi-hole

Run make setup-pihole to configure and start Pi-hole. This script will:

  • Check if port 53 is free (and offer to fix it if systemd-resolved conflicts).
  • Create necessary data directories.
  • Generate or set a password in .env.
  • Enable Docker to start on boot.
  • Start the Pi-hole container (configured to restart automatically).

Useful Commands:

  • make setup-pihole: Initial setup and start.
  • make start-pihole: Start containers.
  • make stop-pihole: Stop containers.
  • make logs-pihole: View logs.
  • make change-password-pihole: Change the admin password.

Homebridge

Run make setup-homebridge to start Homebridge.

  • Access UI: http://<raspberry-pi-ip>:8581
  • Use the UI to install plugins (like homebridge-http-switch) to connect your VPN API or other devices to Apple Home.

Syncthing

Run make setup-syncthing to start Syncthing.

  • Access UI: http://<raspberry-pi-ip>:8384
  • Default folders are stored in ~/syncthing (in your home directory).

Homepage (Dashboard)

Run make setup-homepage to start the dashboard.

  • Access UI: http://<raspberry-pi-ip>:3000
  • Config files are in ./homepage/config.
  • Note: You need to edit ./homepage/config/services.yaml to add API keys for Pi-hole and Syncthing widgets to work properly.