Getting Started
Overview Installation Quick Start
Features
Command Line Flags Media Types Browser Integration Job Management Scheduling Event Hooks Content Extraction Tagging System
Interfaces
Web Interface API Reference
Configuration
Configuration File Data Sources Storage Settings
Misc
Test Links Interesting Sites Related Tools

Quick Start Guide

This quick start guide will help you get up and running with GatherHub in just a few minutes. Follow these steps to start archiving content from various online sources.

Note: This guide assumes you have already completed the installation process.

Starting GatherHub

GatherHub can run in several modes depending on your needs:

Mode Command Description
Web Interface ./gatherhub --web Starts the web interface for managing downloads through your browser
API Server ./gatherhub --api Starts the API server for programmatic access
Background Service ./gatherhub --daemon Runs in the background to automatically process downloads
All-in-one ./gatherhub --web --api --daemon Starts all components (recommended for most users)

First Time Setup

When running GatherHub for the first time, it's recommended to access the web interface to configure settings:

  1. Start GatherHub with the web interface: ./gatherhub --web
  2. Open a web browser and navigate to http://localhost:8060
  3. If prompted, log in with the default credentials (usually admin/admin)
  4. Follow the setup wizard if available, or proceed to the Settings page

Adding Content Sources

GatherHub can import content from various sources:

Browser Bookmarks

  1. Go to Settings > Sources
  2. Click "Add Source"
  3. Select "Firefox Bookmarks" or other browser type
  4. Specify the path to your browser's profile folder or bookmark database (if not path is given it will try to autodetect)
  5. Save the configuration

Manual URL Addition

  1. Navigate to the Jobs page
  2. Click "Add New Job"
  3. Click on Upload Files or Add URLs
  4. Select one or more files (if Upload) or one or more URLs
  5. Optional: Select the appropriate media type (HTML, Videos, Images, etc.)
  6. Click "Add"

Scanning for Content

If you have the daemon running it will automatically scan for new content at the frequency specified in the settings Otherwise to manually scan your configured sources for content:

  1. Go to the Dashboard
  2. Click "Scan Sources" in the Quick Actions section
  3. Review the new content found in the Jobs page

Starting Downloads

If you have the daemon running it will automatically downlad jobs at the frequency specified in the settings Otherwise to manually start processing downloads:

  1. Go to the Dashboard
  2. Click "Process Downloads" in the Quick Actions section
  3. Alternatively, if running in daemon mode, downloads will be processed automatically according to your scheduling settings

Monitoring Progress

You can monitor download progress in several ways:

  • Dashboard: Shows an overview of all jobs by status
  • Jobs Page: Provides detailed information and filtering options
  • Logs: Check app.log and activity.log for detailed operation information

Special Media Types

Some media types require additional configuration:

YouTube Videos

To download YouTube videos (especially age-restricted or private content), you need to configure cookies:

  1. Go to Settings > Cookie Settings
  2. Follow the guide to export YouTube cookies from your browser
  3. Upload the cookies.txt file

Git Repositories

Git repositories are cloned and also made available as ZIP archives (via event hook) for download through the web interface. No special configuration is needed for public repositories.

Web Archives

Web Archive will never be automatically detected and must be manually selected. You cannot mix and match if you enter more than one url; all urls will be crawled and archived if that media type is selected.

Next Steps

After getting started, consider exploring these features:

Search Results

Type to search documentation...