Documentation

Everything you need to install, configure, and run Brega.

System Requirements

ComponentMinimumRecommended
CPUDual-core 1.5 GHzQuad-core 2.0 GHz+
RAM2 GB4 GB+
Storage10 GB free32 GB+ SSD
OSAny Linux, Windows 10+, macOS 12+Ubuntu 22.04 LTS
DockerDocker Engine 20.10+Latest stable
NetworkNeeded for install + card paymentsStable broadband

Installation

Step 1: Install Docker

If you don't have Docker installed:

curl -fsSL https://get.docker.com | sh

On Windows, install Docker Desktop instead.

Step 2: Run the Installer

curl -fsSL https://get.getbrega.com | bash

The installer will prompt you for:

  • Store name — your business name
  • License key — from your purchase confirmation email
  • Database passwords — choose strong passwords (you won't need to remember them)

Installation takes 3-5 minutes depending on your internet speed.

Step 3: Open the POS

Open a browser and navigate to:

http://localhost:3001

First-Time Setup

On first launch, the setup wizard will walk you through:

  1. Create owner account — choose a name and PIN (4-8 digits)
  2. Store settings — name, address, tax rate, receipt header
  3. Add products — scan barcodes, enter manually, or import CSV
  4. Add employees — name, PIN, role (cashier/manager)
  5. Configure hardware — printer, scanner, display (in Settings)

Receipt Printer Setup

Brega supports any ESC/POS compatible thermal printer. Most USB printers are auto-detected.

  1. Connect the printer via USB or network cable
  2. Go to Settings > Hardware > Receipt Printer
  3. Click Detect Printer — the system will find connected printers
  4. Print a test receipt to verify

Cash drawer: If your cash drawer connects to the printer via RJ-11 cable, it will kick open automatically on each cash sale. No additional configuration needed.

Barcode Scanner Setup

USB barcode scanners work immediately — plug in, start scanning. No drivers needed.

For camera-based scanning (using a phone or tablet camera), go to Settings > Hardware > Barcode Scanner and enable the camera scanner option.

Customer Display Setup

Any device with a web browser can be a customer display.

  1. Connect a tablet or monitor to the same network as your POS
  2. Open a browser on the display device
  3. Navigate to http://[POS-IP]:3001/customer-display
  4. The display shows your promotions when idle and the cart during checkout

Upload your own ads in Settings > Display Ads. Only your content appears — no third-party ads, ever.

Weighing Scale Setup

Supported protocols: Generic USB, CAS, Mettler-Toledo, Fairbanks.

  1. Connect the scale via USB serial adapter
  2. Go to Settings > Hardware > Scale
  3. Select the serial port and protocol
  4. Test the connection — weight should appear in real-time

Register & Checkout

The register supports:

  • Barcode scanning — scan to add items
  • Quick-add buttons — configure in Settings for frequent items
  • Manual entry — search by name or enter price directly
  • Split payments — combine cash, card, and EBT in one transaction
  • Age verification — prompts for age-restricted items (tobacco, alcohol)
  • Void / refund — manager PIN required
  • Tips — 15% / 18% / 20% / custom buttons

Inventory Management

  • Add products: Scan barcode, enter details, set price/cost/stock
  • Bulk import: CSV upload for large catalogs
  • Low stock alerts: Set reorder thresholds per product
  • Vendor OCR: Take a photo of a vendor invoice to auto-import products
  • Categories: Organize products for reporting and analytics
  • Barcode labels: Print shelf labels with barcode, name, and price

Tobacco Scan Data

Available on the Pro plan. Go to Settings > Tobacco Scan Data.

  1. Enable each manufacturer (Altria, RJR, ITG, Liggett)
  2. Enter your store's account number for each (we help you register)
  3. Configure reporting frequency (weekly recommended)
  4. Reports auto-generate and can be exported as CSV
  5. Track estimated rebates on the analytics dashboard

Need help registering? Contact us — we set it up for free.

EBT / SNAP Payments

Requires Forage merchant account + FNS certification. Contact us to start the process.

Once certified:

  1. Add Forage API credentials in Settings > Payments > EBT
  2. Mark products as SNAP-eligible in inventory
  3. At checkout, select EBT payment — customer enters PIN on the terminal
  4. Balance check available before payment

Kitchen Order System

For stores with a deli or food prep area:

  • Customer tablet: Customers browse menu and place orders at /customer-display
  • Kitchen display: Staff see incoming orders on a screen at /kitchen-display
  • Register integration: Kitchen orders appear on the register for payment
  • 7 languages: English, Spanish, Arabic, Chinese, Bengali, French, Korean

QuickBooks / Xero Sync

Pro plan feature. Go to Settings > Accounting.

  1. Click Connect for QuickBooks Online or Xero
  2. Authorize the connection (OAuth2 — your credentials are encrypted)
  3. Choose what to sync: sales, products, customers
  4. Auto-sync runs nightly at 11 PM, or trigger manually

Automatic Updates

Brega checks for updates nightly at 3 AM. Critical updates apply automatically. Feature updates are queued and can be applied from Settings > System > Updates.

If an update fails the health check, it automatically rolls back to the previous version. You can also manually trigger updates from the dashboard.

Backup & Restore

Multi-Store plan feature. Go to Settings > Backup.

  • Manual backup: Download a full database export (SQL)
  • Scheduled backups: Configure daily automatic backups
  • Restore: Upload a backup file to restore data

Your data is stored locally. Backups are your responsibility — we recommend keeping copies on a USB drive or cloud storage.

Multi-Store Setup

Multi-Store plan supports up to 5 locations.

  1. Install Brega on each store's machine using the same license key
  2. Each store operates independently with its own local database
  3. Go to Store Management to switch between stores
  4. Cross-store analytics available on the dashboard

License Management

Your license key is entered during installation. To manage your license:

  • View status: Settings > License shows tier, expiry, features
  • Upgrade: Click "Upgrade" to switch to a higher tier via Stripe
  • Billing: Manage subscription at your portal account
  • Regenerate key: If compromised, regenerate from the portal