Web Interface

GatherHub provides a comprehensive web interface for managing your content archiving tasks. This page describes the various sections and features of the web interface.

Accessing the Web Interface

To access the web interface, start GatherHub with the --web flag:

./gatherhub --web

By default, the web interface is available at:

http://localhost:8060

You can configure the host and port in your config.toml file:

[web_interface]
enabled = true
host = "0.0.0.0"  # Listen on all interfaces
port = 8060       # Default port

Authentication

The web interface requires authentication to protect your archived content. By default, you'll need to log in with credentials configured in your config.toml file.

Note: If you haven't changed the default credentials, be sure to update them for security reasons. The passwords are stored as secure hashes in the configuration file.

Changing Default Credentials

To change the default admin password, you can use the -generate-admin-password command line flag:

./gatherhub -generate-admin-password

This command will:

Prompt you to enter a new password
Generate a secure hash of the password
Show the hash that you can then copy into your config.toml file

After running the command, update your configuration file by replacing the existing password hash in the [web_interface] section:

[web_interface]
enabled = true
host = "0.0.0.0"
port = 8060
username = "admin"
password = "YOUR_NEW_PASSWORD_HASH_HERE"  # Replace with the generated hash

Restart GatherHub for the new credentials to take effect.

Dashboard

The dashboard is the main landing page after logging in. It provides:

A summary of job statistics (pending, downloading, completed, failed)
Quick action buttons for common operations
System status information
Recent activity overview

Quick Actions

The dashboard provides buttons for commonly used operations:

Scan Sources: Scan all configured sources for new content
Process Downloads: Start processing pending downloads
Retry Failed: Attempt to download failed jobs again
Clean Up: Remove old and failed jobs
Add URL: Quickly add a new URL to download

Jobs Page

The Jobs page is where you manage all your download tasks. It provides:

A sortable, filterable list of all jobs
Status indicators for each job
Job details like URL, media type, and creation date
Actions for individual jobs
Pagination controls for large job lists

Job Filtering

The Jobs page includes comprehensive filtering options:

Filter by status (pending, downloading, completed, failed)
Filter by media type (HTML, YouTube, Git, etc.)
Search by URL or title text
Filter by tags

Job Details

Clicking on any job opens its details page, which shows:

Complete job metadata
Download history and activity log
File location and download link
Tags management
Action buttons for the job

Settings

The Settings page provides a comprehensive interface for configuring GatherHub:

General Settings

Concurrency options (maximum workers, timeout)
Scheduling configuration

Storage Settings

Base storage path
Media-specific storage paths

Sources

Configure browser bookmark sources
Add and edit SQLite database sources
Test source connections

Cookie Settings

Upload and manage YouTube cookies
View cookie status and validation
Access the cookie setup guide

Media Types

Configure different media types
Set download tools and arguments
Define URL patterns for autodetection

Web & API Settings

Configure web interface settings
Configure API server settings
Manage authentication

Event Hooks

Enable/disable the hook system
Configure hook directory
Manage individual hook scripts

Advanced Settings

Logging configuration
Auto-clean settings
Debug options

Theme Support

The web interface includes multiple theme options for comfortable use in different environments:

Light Theme: Default bright theme for general use
Dark Theme: Reduced brightness for low-light environments
High Contrast: Increased contrast for accessibility

You can switch themes using the dropdown in the top-right corner of the interface.

Mobile Responsiveness

The GatherHub web interface is designed to be responsive and works on mobile devices and tablets. The layout automatically adjusts based on screen size, allowing you to manage your downloads from any device.

Browser Compatibility

The GatherHub web interface is compatible with modern browsers:

Chrome/Chromium
Firefox
Safari
Edge
Brave
Vivaldi