diff --git a/docs/apps/index.html b/docs/apps/index.html new file mode 100644 index 00000000..bf83feff --- /dev/null +++ b/docs/apps/index.html @@ -0,0 +1,72 @@ + + + + + + Huntarr.io Applications Documentation + + + + +
+

Huntarr.io Applications

+ +
+ +
+ +

Huntarr.io provides a unified interface to manage your media automation applications. Each application has its own dedicated documentation page with setup instructions, configuration options, and usage guides.

+ +

Supported Applications

+ +
+

Sonarr

+

Purpose: Manage and automate TV show downloads.

+

Features: Calendar view, automatic searching, series management, quality profiles, and more.

+

View Sonarr Documentation

+
+ +
+

Radarr

+

Purpose: Manage and automate movie downloads.

+

Features: Automatic searching, movie management, quality profiles, and more.

+

View Radarr Documentation

+
+ +
+

Lidarr

+

Purpose: Manage and automate music downloads.

+

Features: Artist management, album tracking, quality profiles, and more.

+

View Lidarr Documentation

+
+ +
+

Readarr

+

Purpose: Manage and automate ebook and audiobook downloads.

+

Features: Author management, book tracking, quality profiles, and more.

+

View Readarr Documentation

+
+ +
+

Whisparr

+

Purpose: Manage and automate adult content downloads.

+

Features: Scene tracking, automatic searching, quality profiles, and more.

+

View Whisparr Documentation

+
+ +
+ ← Back to Home + Settings Documentation → +
+ + +
+ + \ No newline at end of file diff --git a/docs/apps/sonarr.html b/docs/apps/sonarr.html new file mode 100644 index 00000000..cd9bc908 --- /dev/null +++ b/docs/apps/sonarr.html @@ -0,0 +1,146 @@ + + + + + + Sonarr Documentation - Huntarr.io + + + + +
+

Sonarr Documentation

+ +
+ +
+ +
S
+ +

Sonarr is an automated TV show downloading and management application. It works with various torrent and usenet clients to help you organize and manage your TV show collection.

+ +

Getting Started with Sonarr

+ +

Setup in Huntarr.io

+

To set up Sonarr in Huntarr.io:

+
    +
  1. Navigate to the Apps section in the Huntarr.io dashboard
    2. +
  2. Click on "Sonarr" in the application list
    3. +
  3. Click the "Install" button
    4. +
  4. Configure the required settings (see Configuration section below)
    5. +
  5. Click "Deploy" to start the Sonarr container
    6. +
+ +

Configuration Options

+

The following configuration options are available when setting up Sonarr:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescriptionDefaultNotes
PortThe port Sonarr will use8989Change if you have port conflicts
Media PathLocation of your TV shows/mnt/unionfs/tvShould match your media server's TV library path
Download PathWhere downloads are stored/mnt/downloadsShould match your download client's completed download folder
Config PathWhere Sonarr stores its config/opt/appdata/sonarrUsually best to leave as default
+ +

Using Sonarr

+ +

Adding a TV Show

+
    +
  1. Click the "Series" tab in the Sonarr interface
    2. +
  2. Click "Add New" button
    3. +
  3. Search for the TV show you want to add
    4. +
  4. Select the appropriate path, profile, and monitoring options
    5. +
  5. Click "Add" to add the series to Sonarr
    6. +
+ +

Managing Quality Profiles

+

Quality profiles determine what quality of media files Sonarr will download:

+
    +
  1. Go to Settings > Profiles
    2. +
  2. Click the "+" button to add a new profile or edit an existing one
    3. +
  3. Set your preferred qualities and cut-off point (minimum acceptable quality)
    4. +
  4. Save your changes
    5. +
+ +

Setting Up Indexers

+

Indexers are how Sonarr finds content to download:

+
    +
  1. Go to Settings > Indexers
    2. +
  2. Click the "+" button to add a new indexer
    3. +
  3. Select your indexer type (Newznab, Torznab, etc.)
    4. +
  4. Enter the required information (URL, API key, etc.)
    5. +
  5. Test the connection and save if successful
    6. +
+ +

Connecting Download Clients

+

Download clients handle the actual downloading of content:

+
    +
  1. Go to Settings > Download Clients
    2. +
  2. Click the "+" button to add a new download client
    3. +
  3. Select your client type (SABnzbd, NZBGet, qBittorrent, Deluge, etc.)
    4. +
  4. Enter the required connection information
    5. +
  5. Test the connection and save if successful
    6. +
+ +

Troubleshooting

+ +

Common Issues

+ +

Shows Not Being Downloaded

+

Check the following:

+ + +

Path Issues

+

If Sonarr can't find or move files:

+ + +
+ ← Back to Apps + Radarr Documentation → +
+ + +
+ + \ No newline at end of file diff --git a/docs/css/main.css b/docs/css/main.css new file mode 100644 index 00000000..3744d617 --- /dev/null +++ b/docs/css/main.css @@ -0,0 +1,226 @@ +/* Huntarr.io Documentation Styles */ +:root { + --primary-color: #252a34; + --secondary-color: #3498db; + --background-color: #f5f5f5; + --text-color: #333; + --sonarr-color: #3498db; /* Blue */ + --radarr-color: #f1c40f; /* Yellow */ + --lidarr-color: #2ecc71; /* Green */ + --readarr-color: #e74c3c; /* Red */ + --whisparr-color: #9b59b6; /* Purple */ +} + +body { + font-family: 'Arial', sans-serif; + line-height: 1.6; + color: var(--text-color); + max-width: 1000px; + margin: 0 auto; + padding: 20px; + background-color: var(--background-color); +} + +.container { + background-color: white; + padding: 30px; + border-radius: 8px; + box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1); +} + +h1 { + color: var(--primary-color); + text-align: center; + margin-bottom: 30px; + padding-bottom: 15px; + border-bottom: 2px solid var(--primary-color); +} + +h2 { + color: var(--primary-color); + margin-top: 30px; + margin-bottom: 15px; + padding-bottom: 5px; + border-bottom: 1px solid #eee; +} + +h3 { + margin-top: 25px; + color: #444; +} + +a { + color: var(--secondary-color); + text-decoration: none; + transition: color 0.3s; +} + +a:hover { + color: #217dbb; + text-decoration: underline; +} + +.app-icons { + display: flex; + justify-content: center; + gap: 20px; + margin: 30px 0; +} + +.app-icon { + width: 50px; + height: 50px; + border-radius: 50%; + display: flex; + align-items: center; + justify-content: center; + color: white; + font-weight: bold; +} + +.app-box { + margin: 20px 0; + padding: 15px; + border-radius: 8px; + border-left: 4px solid; +} + +.app-box.sonarr { border-left-color: var(--sonarr-color); } +.app-box.radarr { border-left-color: var(--radarr-color); } +.app-box.lidarr { border-left-color: var(--lidarr-color); } +.app-box.readarr { border-left-color: var(--readarr-color); } +.app-box.whisparr { border-left-color: var(--whisparr-color); } +.sonarr { background-color: var(--sonarr-color); } +.radarr { background-color: var(--radarr-color); } +.lidarr { background-color: var(--lidarr-color); } +.readarr { background-color: var(--readarr-color); } +.whisparr { background-color: var(--whisparr-color); } + +.section-nav { + display: flex; + justify-content: space-between; + margin: 30px 0; + padding: 10px 0; + border-top: 1px solid #eee; + border-bottom: 1px solid #eee; +} + +code { + background-color: #f8f9fa; + padding: 2px 6px; + border-radius: 3px; + border: 1px solid #eee; + font-family: 'Courier New', monospace; + font-size: 0.9em; +} + +pre { + background-color: #f8f9fa; + padding: 15px; + border-radius: 5px; + border: 1px solid #eee; + overflow-x: auto; +} + +img { + max-width: 100%; + height: auto; + border-radius: 5px; + margin: 10px 0; +} + +table { + width: 100%; + border-collapse: collapse; + margin: 20px 0; +} + +table, th, td { + border: 1px solid #eee; +} + +th, td { + padding: 10px; + text-align: left; +} + +th { + background-color: #f8f9fa; +} + +footer { + text-align: center; + margin-top: 40px; + padding-top: 20px; + font-size: 0.9em; + color: #777; + border-top: 1px solid #eee; +} + +/* Responsive styles */ +@media (max-width: 768px) { + .app-icons { + flex-wrap: wrap; + } + + .container { + padding: 15px; + } +} + +/* Navigation menu */ +.nav-menu { + margin-bottom: 30px; +} + +.nav-menu ul { + display: flex; + list-style: none; + padding: 0; + margin: 0; + background-color: var(--primary-color); + border-radius: 5px; + overflow: hidden; +} + +.nav-menu li { + flex: 1; + text-align: center; +} + +.nav-menu li a { + display: block; + color: white; + padding: 12px 15px; + text-decoration: none; + transition: background-color 0.3s; +} + +.nav-menu li a:hover { + background-color: rgba(255, 255, 255, 0.1); + text-decoration: none; +} + +.nav-menu li.active a { + background-color: var(--secondary-color); +} + +/* Info icon */ +.info-link { + display: inline-block; + width: 20px; + height: 20px; + background-color: var(--secondary-color); + color: white; + border-radius: 50%; + text-align: center; + line-height: 20px; + font-weight: bold; + margin-left: 5px; + text-decoration: none; +} + +.info-link:hover { + background-color: #217dbb; + text-decoration: none; +} \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index b54ec0ce..3de6c3e6 100644 --- a/docs/index.html +++ b/docs/index.html @@ -4,63 +4,23 @@ Official Huntarr.io Documentation - + +

Welcome to Huntarr.io Documentation

-

Thank you for using Huntarr.io! This documentation site is currently under construction and will soon contain comprehensive guides, tutorials, and reference materials for all Huntarr features.

+
+ +
+ +

Thank you for using Huntarr.io! This documentation site provides comprehensive guides, tutorials, and reference materials for all Huntarr features.

S
@@ -73,15 +33,25 @@

Huntarr.io is a powerful management tool for your media automation stack, providing simplified control over:

-

Check back soon for complete documentation!

+

Documentation Sections

+ +
+

Applications Documentation

+

Detailed information about each Huntarr-supported application, including setup, configuration, and usage guides.

+
+ +
+

Settings Documentation

+

Learn about all Huntarr.io settings and configurations to optimize your media management experience.

+