Skip to Content
CLI Referenceqb generate

qb generate - Generate System Information

Generate System Logs

Create comprehensive system reports for troubleshooting and support

The qb generate functions create essential system reports. The primary function is qb generate log, which produces a full snapshot of system stats, QuickBox API activation (against the v3.quickbox.io license endpoint), web stack versions, mounts, and curated log tails—perfect for troubleshooting or support.

Quick Reference

CommandDescription
qb generate log
Generate comprehensive system logs and server information

Generate System Logs

Create a detailed system log report for troubleshooting and support:

bash
qb generate log

What’s included in the report:

System Information

  • Operating system details
  • Kernel version
  • CPU and memory info
  • Disk usage and mounts
  • Network configuration

QuickBox Details

  • QuickBox version
  • API activation (V3 qbp_ keys and legacy keys)
  • PHP/Nginx version and database engine
  • Apt updates available + last upgrade time
  • Application log tails per user
API status sources
Note

qb generate log automatically detects qbp_ keys and queries the new V3 API; legacy keys keep using the current status endpoint. Both paths record activation state, execution time, and (when available) plan/seat limits.

Accessing Generated Logs

After running qb generate log, you can access the system log file in three ways:

Note

Navigate to System → Troubleshooting → System Log in your QuickBox dashboard.

Here you can generate and/or download the system log summary produced by the generate log command. The dashboard consumes the same file written by qb generate log (served by qblogminer.service).

Steps:

  1. Log into QuickBox dashboard
  2. Click System in the sidebar
  3. Select Troubleshooting
  4. Click System Log
  5. Generate new log or download existing one

2. View System Logs Section

Note

Navigate to System → System Logs in your QuickBox dashboard.

Here you can find additional logs and information gathered by the generate log command.

Available logs:

  • System log summary
  • Application log tails (per user)
  • Auth/syslog/fail2ban/nginx/php-fpm snippets
  • Mount information

3. Direct Server Access

Access the log file directly on your server:

bash
# View the log file
cat /opt/quickbox/logs/system_log
 
# Or view with pagination
less /opt/quickbox/logs/system_log
 
# Copy to another location
cp /opt/quickbox/logs/system_log ~/system_log_backup.txt

File location:

/opt/quickbox/logs/system_log

When to Generate System Logs

Before Requesting Support

Support Best Practice
Tip

Always generate system logs before asking for help in Discord. This helps support staff quickly understand your setup and diagnose issues.

bash
# 1. Generate fresh system logs
qb generate log
 
# 2. Download from dashboard or copy file
# 3. Share in Discord support channel

Troubleshooting Issues

When experiencing problems:

bash
# Generate logs to see system state
qb generate log
 
# Review the log file for errors
less /opt/quickbox/logs/system_log
 
# Look for:
# - Failed services
# - Disk space issues
# - API activation problems
# - Mount failures

After System Changes

Document system state after major changes:

bash
# After OS upgrade
qb generate log
cp /opt/quickbox/logs/system_log ~/logs/after_upgrade_$(date +%Y%m%d).txt
 
# After installing applications
qb generate log
 
# After configuration changes
qb generate log

Regular Maintenance

Monthly system snapshots:

bash
#!/bin/bash
# Save monthly system snapshot
qb generate log
mkdir -p ~/monthly_logs
cp /opt/quickbox/logs/system_log ~/monthly_logs/system_log_$(date +%Y%m).txt

Understanding the System Log

Key Sections

The generated system log contains several important sections:

System Information

plaintext
Operating System: Debian GNU/Linux 12 (bookworm)
Kernel: Linux 6.1.0-18-amd64
CPU: Intel(R) Xeon(R) CPU E5-2680 v4 @ 2.40GHz (8 cores)
Memory: 16GB

QuickBox Status

plaintext
QuickBox Version: 3.2.2
API Status: active (V3)
API Key: qbp_xxxx...abcd
Activations: 1/3 • Seats: 3/10 • Expires: never
Last Check: 2025-11-24 15:30:42

Disk Usage

plaintext
Filesystem      Size  Used Avail Use% Mounted on
/dev/sda1       500G  120G  355G  26% /
/dev/sdb1       2.0T  800G  1.1T  42% /home

Application Logs (per user)

plaintext
logs/apps/john/sonarr.log: [last 5 lines]
logs/apps/john/radarr.log: [last 5 lines]
logs/apps/jane/plex.log: [last 5 lines]

Selected Log Snippets

plaintext
auth.log (tail -5)
syslog (tail -5)
fail2ban.log (tail -5)
nginx/qbdash_error.log (tail -5)
php8.1-fpm.log (tail -5)
nginx/access.log (tail -5)
quickbox.log (tail -5, UI commands)

Troubleshooting

Log Generation Fails

bash
# Check if log directory exists
ls -la /opt/quickbox/logs/
 
# Create if missing
mkdir -p /opt/quickbox/logs
 
# Check permissions
ls -la /opt/quickbox/
 
# Try again
qb generate log

Empty or Incomplete Log

bash
# Check disk space
df -h
 
# Check for errors
journalctl -u v4-dashboard -n 50
 
# Regenerate
qb generate log

Can’t Access Log File

bash
# Check file exists
ls -la /opt/quickbox/logs/system_log
 
# Check permissions
sudo chmod 644 /opt/quickbox/logs/system_log
 
# View with sudo if needed
sudo cat /opt/quickbox/logs/system_log

Best Practices

Do

  • Generate logs before requesting support
  • Save logs after major system changes
  • Keep monthly system snapshots
  • Review logs for unusual activity
  • Document system state periodically
  • Share logs when reporting bugs

Don't

  • Share logs publicly (may contain sensitive info)
  • Ignore errors in generated logs
  • Generate logs excessively (unnecessary load)
  • Forget to regenerate after changes
  • Skip log review when troubleshooting
  • Delete old logs without reviewing first

Security Considerations

Sensitive Information
Warning

System logs may contain sensitive information including IP addresses, usernames, and system configuration details. Handle with care.

What might be sensitive:

  • Server IP addresses
  • User account names
  • API keys (may be redacted)
  • Directory structures
  • Installed software versions
  • Network configuration

Safe sharing practices:

  • Only share in private support channels
  • Redact sensitive information if sharing publicly
  • Don’t post logs in public forums
  • Use Discord DMs for sensitive logs
  • Remove logs after issue is resolved
Clean Command

Clean old logs and free up space

Fix Command

Fix common system issues

Support Command

Enable temporary support access

Update Command

Update QuickBox to latest version

Need Help?

Join the Community

Media server operators sharing configs, getting support, and shaping the future of QuickBox Pro.

  • Dedicated Support
  • Feature Previews
  • Community Configs
  • Active Discussions
Join Discord Server

Additional Resources

Getting Started

Complete installation guide

CLI Reference

All available commands

Troubleshooting

Common issues and solutions

Last updated on
qb updateqb support