Skip to content

Usage

Setting up an OPNsense Instance

  1. Access the web interface at http://your-server:5000
  2. Log in with the default credentials (change immediately after first login!)
  3. Default username: admin
  4. Default password: Set via ADMIN_PASSWORD environment variable
  5. Navigate to "Instances" and click "Add Instance"
  6. Fill in:
  7. Name: Friendly name for the instance (e.g., "Main Router")
  8. Identifier: Unique identifier (e.g., "lan") - used as SFTP username
  9. Description: Optional description
  10. Click "Create Instance"

Configuring OPNsense

  1. In OPNsense, navigate to System → Configuration → Backups
  2. Add a new backup target:
  3. Type: SFTP
  4. Target location (URI): Copy from the instance detail page (e.g., sftp://[email protected]:30222//lan)
  5. SSH Private Key: Copy or download the private key from the instance detail page
  6. Configure your backup schedule and save
  7. Test the backup connection to verify authentication works

Accessing Backups

  • View all backups in the "Backups" section
  • Download backups by clicking the "Download" link
  • View instance-specific backups from the instance detail page