BookBounty Setup Guide - ajgillis04/GillisDockerDepot GitHub Wiki

BookBounty Setup Guide

Introduction

BookBounty is a self-hosted book management and search application that helps you organize and search for books in your collection.

Prerequisites

  • Docker installed
  • BookBounty container running in your Docker stack

Configuration Steps

Step 1: Accessing the BookBounty UI

  1. Open your browser and navigate to http://<your-ip-address>:<port>.
  2. Log in with your BookBounty credentials.

Step 2: Initial Setup Wizard

  1. Follow the initial setup wizard to configure basic settings.
  2. Choose your preferred language for the BookBounty interface.

Step 3: Adding Libraries

  1. Navigate to the Libraries tab.
  2. Click Add Library.
  3. Configure the library settings:
    • Library Name: Give your library a meaningful name.
    • Library Path: Enter the path to your book files.
  4. Click Save.

Step 4: Configuring Indexers

  1. Go to the Indexers tab.
  2. Click Add Indexer.
  3. Select the indexers you want to use and enter the necessary API keys or login credentials.
  4. Click Save.

Step 5: Setting Up Custom Tags

  1. Navigate to the Tags tab.
  2. Click Add Tag.
  3. Configure the tag settings (e.g., genre, author).
  4. Click Save.

Step 6: Customizing Settings

  1. Go to the Settings section.
  2. Customize the settings according to your preferences (e.g., notification settings, appearance).
  3. Click Save.

Notes

  • Ensure all paths and environment variables are updated in the bookbounty.yaml file.
  • Regularly backup your config directory to save your settings.

Troubleshooting

  • Common Issues: List common issues and solutions.
  • Logs: Check BookBounty logs for error messages.
  • Support: Link to the BookBounty community and support resources.
⚠️ **GitHub.com Fallback** ⚠️