Skip to content

getting-started.md

Latest commit

 

History

History
101 lines (69 loc) · 3.04 KB

getting-started.md

File metadata and controls

101 lines (69 loc) · 3.04 KB

Getting Started with BenchPress

This guide walks you through your first BenchPress setup — from installation to deploying your first Frappe bench.

Prerequisites

Before installing BenchPress, ensure your host machine has:

Requirement Version Purpose
Frappe Bench v16 The bench environment to install BenchPress into
Docker Engine 20+ Container management
Docker Compose v2+ Manages shared MariaDB + Redis infrastructure
WireGuard Any VPN access (optional but recommended)

MariaDB and Redis for bench containers are managed automatically via Docker Compose. You only need them on the host for Frappe itself.

Installation

Step 1: Install the app

cd /path/to/your/frappe-bench

bench get-app https://github.com/Venkateshvenki404224/benchpress --branch develop
bench pip install docker
bench --site your-site.localhost install-app benchpress
bench --site your-site.localhost migrate

Step 2: Run the setup script

bash apps/benchpress/setup.sh your-site.localhost

The setup script is idempotent (safe to run multiple times) and handles six steps:

  1. Docker group — Adds your user to the docker group
  2. Shared infrastructure — Starts benchpress-mariadb and benchpress-redis via docker-compose
  3. IP forwarding — Enables kernel IP forwarding for VPN routing
  4. Sudoers — Configures passwordless sudo for WireGuard commands
  5. WireGuard tools — Installs wireguard-tools if missing
  6. WireGuard server — Generates keys and brings up the wg0 interface

If the Docker group was just added, log out and back in before starting bench.

Step 3: Build the frontend

cd apps/benchpress/frontend
yarn install
yarn build

Step 4: Configure BenchPress Settings

Settings

  1. Start the bench: bench start
  2. Open BenchPress Settings in your browser: /app/benchpress-settings
  3. Fill in the WireGuard fields (values are printed by the setup script):
    • WG Server Public Key
    • WG Server Endpoint — Your server's public IP (curl -s ifconfig.me)
    • WG Server Port — 51820

Step 5: Open firewall

sudo ufw allow 51820/udp

Step 6: Access the dashboard

Open your browser to:

http://your-site.localhost:8000/frontend

Your First Lab and Bench

Once BenchPress is running, follow the Creating Labs guide to create your first lab template and deploy a bench instance.

What's Next?

Guide Description
Creating Labs Create lab templates and deploy bench instances
Connecting to Benches SSH access, VPN setup, and connection info
Logs and Monitoring Build logs, deploy logs, and container stats
VPN Device Management Register devices for persistent WireGuard access
WireGuard Setup Detailed WireGuard configuration and troubleshooting
⚡