mirror of
https://github.com/plexguide/Huntarr.io.git
synced 2026-01-05 21:50:09 -06:00
docs: create comprehensive documentation structure with app and settings pages
This commit is contained in:
72
docs/apps/index.html
Normal file
72
docs/apps/index.html
Normal file
@@ -0,0 +1,72 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Huntarr.io Applications Documentation</title>
|
||||
<link rel="stylesheet" href="../css/main.css">
|
||||
<script src="../js/main.js" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<h1>Huntarr.io Applications</h1>
|
||||
|
||||
<div class="nav-menu">
|
||||
<ul>
|
||||
<li><a href="../index.html">Home</a></li>
|
||||
<li class="active"><a href="index.html">Apps</a></li>
|
||||
<li><a href="../settings/index.html">Settings</a></li>
|
||||
<li><a href="https://github.com/plexguide/Huntarr.io" target="_blank">GitHub</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<h2>Supported Applications</h2>
|
||||
|
||||
<div class="app-box sonarr">
|
||||
<h3><a href="sonarr.html">Sonarr</a></h3>
|
||||
<p><strong>Purpose:</strong> Manage and automate TV show downloads.</p>
|
||||
<p><strong>Features:</strong> Calendar view, automatic searching, series management, quality profiles, and more.</p>
|
||||
<p><a href="sonarr.html">View Sonarr Documentation</a></p>
|
||||
</div>
|
||||
|
||||
<div class="app-box radarr">
|
||||
<h3><a href="radarr.html">Radarr</a></h3>
|
||||
<p><strong>Purpose:</strong> Manage and automate movie downloads.</p>
|
||||
<p><strong>Features:</strong> Automatic searching, movie management, quality profiles, and more.</p>
|
||||
<p><a href="radarr.html">View Radarr Documentation</a></p>
|
||||
</div>
|
||||
|
||||
<div class="app-box lidarr">
|
||||
<h3><a href="lidarr.html">Lidarr</a></h3>
|
||||
<p><strong>Purpose:</strong> Manage and automate music downloads.</p>
|
||||
<p><strong>Features:</strong> Artist management, album tracking, quality profiles, and more.</p>
|
||||
<p><a href="lidarr.html">View Lidarr Documentation</a></p>
|
||||
</div>
|
||||
|
||||
<div class="app-box readarr">
|
||||
<h3><a href="readarr.html">Readarr</a></h3>
|
||||
<p><strong>Purpose:</strong> Manage and automate ebook and audiobook downloads.</p>
|
||||
<p><strong>Features:</strong> Author management, book tracking, quality profiles, and more.</p>
|
||||
<p><a href="readarr.html">View Readarr Documentation</a></p>
|
||||
</div>
|
||||
|
||||
<div class="app-box whisparr">
|
||||
<h3><a href="whisparr.html">Whisparr</a></h3>
|
||||
<p><strong>Purpose:</strong> Manage and automate adult content downloads.</p>
|
||||
<p><strong>Features:</strong> Scene tracking, automatic searching, quality profiles, and more.</p>
|
||||
<p><a href="whisparr.html">View Whisparr Documentation</a></p>
|
||||
</div>
|
||||
|
||||
<div class="section-nav">
|
||||
<a href="../index.html">← Back to Home</a>
|
||||
<a href="../settings/index.html">Settings Documentation →</a>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
Huntarr.io v6.5.18 | Applications Documentation | Thanks 4 Using Huntarr - Admin9705
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
146
docs/apps/sonarr.html
Normal file
146
docs/apps/sonarr.html
Normal file
@@ -0,0 +1,146 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Sonarr Documentation - Huntarr.io</title>
|
||||
<link rel="stylesheet" href="../css/main.css">
|
||||
<script src="../js/main.js" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<h1>Sonarr Documentation</h1>
|
||||
|
||||
<div class="nav-menu">
|
||||
<ul>
|
||||
<li><a href="../index.html">Home</a></li>
|
||||
<li class="active"><a href="index.html">Apps</a></li>
|
||||
<li><a href="../settings/index.html">Settings</a></li>
|
||||
<li><a href="https://github.com/plexguide/Huntarr.io" target="_blank">GitHub</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="app-icon sonarr" style="margin: 20px auto; width: 80px; height: 80px; font-size: 36px;">S</div>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<h2>Getting Started with Sonarr</h2>
|
||||
|
||||
<h3>Setup in Huntarr.io</h3>
|
||||
<p>To set up Sonarr in Huntarr.io:</p>
|
||||
<ol>
|
||||
<li>Navigate to the Apps section in the Huntarr.io dashboard</li>
|
||||
<li>Click on "Sonarr" in the application list</li>
|
||||
<li>Click the "Install" button</li>
|
||||
<li>Configure the required settings (see Configuration section below)</li>
|
||||
<li>Click "Deploy" to start the Sonarr container</li>
|
||||
</ol>
|
||||
|
||||
<h3>Configuration Options</h3>
|
||||
<p>The following configuration options are available when setting up Sonarr:</p>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Option</th>
|
||||
<th>Description</th>
|
||||
<th>Default</th>
|
||||
<th>Notes</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Port</td>
|
||||
<td>The port Sonarr will use</td>
|
||||
<td>8989</td>
|
||||
<td>Change if you have port conflicts</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Media Path</td>
|
||||
<td>Location of your TV shows</td>
|
||||
<td>/mnt/unionfs/tv</td>
|
||||
<td>Should match your media server's TV library path</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Download Path</td>
|
||||
<td>Where downloads are stored</td>
|
||||
<td>/mnt/downloads</td>
|
||||
<td>Should match your download client's completed download folder</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Config Path</td>
|
||||
<td>Where Sonarr stores its config</td>
|
||||
<td>/opt/appdata/sonarr</td>
|
||||
<td>Usually best to leave as default</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h2>Using Sonarr</h2>
|
||||
|
||||
<h3>Adding a TV Show</h3>
|
||||
<ol>
|
||||
<li>Click the "Series" tab in the Sonarr interface</li>
|
||||
<li>Click "Add New" button</li>
|
||||
<li>Search for the TV show you want to add</li>
|
||||
<li>Select the appropriate path, profile, and monitoring options</li>
|
||||
<li>Click "Add" to add the series to Sonarr</li>
|
||||
</ol>
|
||||
|
||||
<h3>Managing Quality Profiles</h3>
|
||||
<p>Quality profiles determine what quality of media files Sonarr will download:</p>
|
||||
<ol>
|
||||
<li>Go to Settings > Profiles</li>
|
||||
<li>Click the "+" button to add a new profile or edit an existing one</li>
|
||||
<li>Set your preferred qualities and cut-off point (minimum acceptable quality)</li>
|
||||
<li>Save your changes</li>
|
||||
</ol>
|
||||
|
||||
<h3>Setting Up Indexers</h3>
|
||||
<p>Indexers are how Sonarr finds content to download:</p>
|
||||
<ol>
|
||||
<li>Go to Settings > Indexers</li>
|
||||
<li>Click the "+" button to add a new indexer</li>
|
||||
<li>Select your indexer type (Newznab, Torznab, etc.)</li>
|
||||
<li>Enter the required information (URL, API key, etc.)</li>
|
||||
<li>Test the connection and save if successful</li>
|
||||
</ol>
|
||||
|
||||
<h3>Connecting Download Clients</h3>
|
||||
<p>Download clients handle the actual downloading of content:</p>
|
||||
<ol>
|
||||
<li>Go to Settings > Download Clients</li>
|
||||
<li>Click the "+" button to add a new download client</li>
|
||||
<li>Select your client type (SABnzbd, NZBGet, qBittorrent, Deluge, etc.)</li>
|
||||
<li>Enter the required connection information</li>
|
||||
<li>Test the connection and save if successful</li>
|
||||
</ol>
|
||||
|
||||
<h2>Troubleshooting</h2>
|
||||
|
||||
<h3>Common Issues</h3>
|
||||
|
||||
<h4>Shows Not Being Downloaded</h4>
|
||||
<p>Check the following:</p>
|
||||
<ul>
|
||||
<li>Ensure your indexers are properly configured and working</li>
|
||||
<li>Verify your download client is running and accessible</li>
|
||||
<li>Check that your quality profile isn't too restrictive</li>
|
||||
<li>Look at the "Wanted" tab to see if shows are in the queue</li>
|
||||
</ul>
|
||||
|
||||
<h4>Path Issues</h4>
|
||||
<p>If Sonarr can't find or move files:</p>
|
||||
<ul>
|
||||
<li>Ensure the user running Sonarr has proper permissions</li>
|
||||
<li>Verify your paths are consistent between Sonarr and your download client</li>
|
||||
<li>Check for path mapping issues if running in Docker</li>
|
||||
</ul>
|
||||
|
||||
<div class="section-nav">
|
||||
<a href="index.html">← Back to Apps</a>
|
||||
<a href="radarr.html">Radarr Documentation →</a>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
Huntarr.io v6.5.18 | Sonarr Documentation | Thanks 4 Using Huntarr - Admin9705
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
226
docs/css/main.css
Normal file
226
docs/css/main.css
Normal file
@@ -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;
|
||||
}
|
||||
@@ -4,63 +4,23 @@
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Official Huntarr.io Documentation</title>
|
||||
<style>
|
||||
body {
|
||||
font-family: 'Arial', sans-serif;
|
||||
line-height: 1.6;
|
||||
color: #333;
|
||||
max-width: 800px;
|
||||
margin: 0 auto;
|
||||
padding: 20px;
|
||||
background-color: #f5f5f5;
|
||||
}
|
||||
.container {
|
||||
background-color: white;
|
||||
padding: 30px;
|
||||
border-radius: 8px;
|
||||
box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1);
|
||||
}
|
||||
h1 {
|
||||
color: #252a34;
|
||||
text-align: center;
|
||||
margin-bottom: 30px;
|
||||
padding-bottom: 15px;
|
||||
border-bottom: 2px solid #252a34;
|
||||
}
|
||||
.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;
|
||||
}
|
||||
.sonarr { background-color: #3498db; } /* Blue */
|
||||
.radarr { background-color: #f1c40f; } /* Yellow */
|
||||
.lidarr { background-color: #2ecc71; } /* Green */
|
||||
.readarr { background-color: #e74c3c; } /* Red */
|
||||
.whisparr { background-color: #9b59b6; } /* Purple */
|
||||
footer {
|
||||
text-align: center;
|
||||
margin-top: 40px;
|
||||
font-size: 0.9em;
|
||||
color: #777;
|
||||
}
|
||||
</style>
|
||||
<link rel="stylesheet" href="css/main.css">
|
||||
<script src="js/main.js" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<h1>Welcome to Huntarr.io Documentation</h1>
|
||||
|
||||
<p>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.</p>
|
||||
<div class="nav-menu">
|
||||
<ul>
|
||||
<li class="active"><a href="index.html">Home</a></li>
|
||||
<li><a href="apps/index.html">Apps</a></li>
|
||||
<li><a href="settings/index.html">Settings</a></li>
|
||||
<li><a href="https://github.com/plexguide/Huntarr.io" target="_blank">GitHub</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<p>Thank you for using Huntarr.io! This documentation site provides comprehensive guides, tutorials, and reference materials for all Huntarr features.</p>
|
||||
|
||||
<div class="app-icons">
|
||||
<div class="app-icon sonarr">S</div>
|
||||
@@ -73,15 +33,25 @@
|
||||
<p>Huntarr.io is a powerful management tool for your media automation stack, providing simplified control over:</p>
|
||||
|
||||
<ul>
|
||||
<li>Sonarr (TV Shows)</li>
|
||||
<li>Radarr (Movies)</li>
|
||||
<li>Lidarr (Music)</li>
|
||||
<li>Readarr (Books)</li>
|
||||
<li>Whisparr (Adult Content)</li>
|
||||
<li><a href="apps/sonarr.html">Sonarr</a> (TV Shows)</li>
|
||||
<li><a href="apps/radarr.html">Radarr</a> (Movies)</li>
|
||||
<li><a href="apps/lidarr.html">Lidarr</a> (Music)</li>
|
||||
<li><a href="apps/readarr.html">Readarr</a> (Books)</li>
|
||||
<li><a href="apps/whisparr.html">Whisparr</a> (Adult Content)</li>
|
||||
<li>And more!</li>
|
||||
</ul>
|
||||
|
||||
<p>Check back soon for complete documentation!</p>
|
||||
<h2>Documentation Sections</h2>
|
||||
|
||||
<div class="app-box sonarr">
|
||||
<h3><a href="apps/index.html">Applications Documentation</a></h3>
|
||||
<p>Detailed information about each Huntarr-supported application, including setup, configuration, and usage guides.</p>
|
||||
</div>
|
||||
|
||||
<div class="app-box radarr">
|
||||
<h3><a href="settings/index.html">Settings Documentation</a></h3>
|
||||
<p>Learn about all Huntarr.io settings and configurations to optimize your media management experience.</p>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
Huntarr.io v6.5.18 | Test Deployment | Thanks 4 Using Huntarr - Admin9705
|
||||
|
||||
90
docs/js/main.js
Normal file
90
docs/js/main.js
Normal file
@@ -0,0 +1,90 @@
|
||||
// Huntarr.io Documentation JavaScript
|
||||
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
// Add copy functionality to code blocks
|
||||
const codeBlocks = document.querySelectorAll('pre code');
|
||||
if (codeBlocks.length > 0) {
|
||||
codeBlocks.forEach(function(codeBlock) {
|
||||
const copyButton = document.createElement('button');
|
||||
copyButton.className = 'copy-button';
|
||||
copyButton.textContent = 'Copy';
|
||||
copyButton.addEventListener('click', function() {
|
||||
const code = codeBlock.textContent;
|
||||
navigator.clipboard.writeText(code).then(function() {
|
||||
copyButton.textContent = 'Copied!';
|
||||
setTimeout(function() {
|
||||
copyButton.textContent = 'Copy';
|
||||
}, 2000);
|
||||
}).catch(function(err) {
|
||||
console.error('Could not copy text: ', err);
|
||||
});
|
||||
});
|
||||
|
||||
const pre = codeBlock.parentNode;
|
||||
pre.style.position = 'relative';
|
||||
copyButton.style.position = 'absolute';
|
||||
copyButton.style.right = '10px';
|
||||
copyButton.style.top = '10px';
|
||||
copyButton.style.padding = '5px 10px';
|
||||
copyButton.style.background = '#f1f1f1';
|
||||
copyButton.style.border = '1px solid #ccc';
|
||||
copyButton.style.borderRadius = '3px';
|
||||
copyButton.style.cursor = 'pointer';
|
||||
pre.appendChild(copyButton);
|
||||
});
|
||||
}
|
||||
|
||||
// Check for info icon links
|
||||
const infoLinks = document.querySelectorAll('.info-link');
|
||||
if (infoLinks.length > 0) {
|
||||
infoLinks.forEach(function(link) {
|
||||
link.setAttribute('title', 'Click for documentation');
|
||||
});
|
||||
}
|
||||
|
||||
// Add active class to current page in navigation
|
||||
const currentPath = window.location.pathname;
|
||||
const navLinks = document.querySelectorAll('.nav-menu li a');
|
||||
if (navLinks.length > 0) {
|
||||
navLinks.forEach(function(link) {
|
||||
const linkPath = link.getAttribute('href');
|
||||
// Check if the current path contains the link path (for sub-pages)
|
||||
if (currentPath.includes(linkPath) && linkPath !== '../index.html') {
|
||||
link.parentNode.classList.add('active');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// Add smooth scrolling for anchor links
|
||||
const anchorLinks = document.querySelectorAll('a[href^="#"]');
|
||||
if (anchorLinks.length > 0) {
|
||||
anchorLinks.forEach(function(link) {
|
||||
link.addEventListener('click', function(e) {
|
||||
e.preventDefault();
|
||||
const targetId = this.getAttribute('href');
|
||||
if (targetId === '#') return;
|
||||
|
||||
const targetElement = document.querySelector(targetId);
|
||||
if (targetElement) {
|
||||
window.scrollTo({
|
||||
top: targetElement.offsetTop - 20,
|
||||
behavior: 'smooth'
|
||||
});
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
// Add version check notification
|
||||
const footer = document.querySelector('footer');
|
||||
if (footer) {
|
||||
const versionText = footer.textContent;
|
||||
const versionMatch = versionText.match(/v(\d+\.\d+\.\d+)/);
|
||||
if (versionMatch) {
|
||||
const currentVersion = versionMatch[1];
|
||||
// This would typically check against an API endpoint for the latest version
|
||||
// This is just a placeholder for demonstration
|
||||
console.log(`Current documentation version: ${currentVersion}`);
|
||||
}
|
||||
}
|
||||
});
|
||||
126
docs/settings/general.html
Normal file
126
docs/settings/general.html
Normal file
@@ -0,0 +1,126 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>General Settings - Huntarr.io Documentation</title>
|
||||
<link rel="stylesheet" href="../css/main.css">
|
||||
<script src="../js/main.js" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<h1>General Settings</h1>
|
||||
|
||||
<div class="nav-menu">
|
||||
<ul>
|
||||
<li><a href="../index.html">Home</a></li>
|
||||
<li><a href="../apps/index.html">Apps</a></li>
|
||||
<li class="active"><a href="index.html">Settings</a></li>
|
||||
<li><a href="https://github.com/plexguide/Huntarr.io" target="_blank">GitHub</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<p>The General Settings section allows you to configure basic options for your Huntarr.io instance.</p>
|
||||
|
||||
<h2>System Settings</h2>
|
||||
|
||||
<h3>Application Name</h3>
|
||||
<p>You can customize the name of your Huntarr.io instance that appears in the title bar and navbar. This is useful if you're running multiple instances.</p>
|
||||
<p><strong>Default:</strong> Huntarr.io</p>
|
||||
|
||||
<h3>UI Theme</h3>
|
||||
<p>Choose between different UI themes for your Huntarr.io interface:</p>
|
||||
<ul>
|
||||
<li><strong>Light:</strong> Default light theme</li>
|
||||
<li><strong>Dark:</strong> Dark theme for low-light environments</li>
|
||||
<li><strong>System:</strong> Follows your system's dark/light mode settings</li>
|
||||
</ul>
|
||||
|
||||
<h3>Language</h3>
|
||||
<p>Select the language for the Huntarr.io UI. Current supported languages include:</p>
|
||||
<ul>
|
||||
<li>English (Default)</li>
|
||||
<li>Spanish</li>
|
||||
<li>French</li>
|
||||
<li>German</li>
|
||||
<li>Italian</li>
|
||||
<li>More languages are being added regularly</li>
|
||||
</ul>
|
||||
|
||||
<h2>Updates</h2>
|
||||
|
||||
<h3>Update Channel</h3>
|
||||
<p>Select which update channel to use:</p>
|
||||
<ul>
|
||||
<li><strong>Stable:</strong> Recommended for most users. Includes thoroughly tested updates.</li>
|
||||
<li><strong>Beta:</strong> Preview newer features before they reach stable. May contain bugs.</li>
|
||||
<li><strong>Nightly:</strong> Latest development builds. Not recommended for production use.</li>
|
||||
</ul>
|
||||
|
||||
<h3>Automatic Updates</h3>
|
||||
<p>Configure how Huntarr.io handles updates:</p>
|
||||
<ul>
|
||||
<li><strong>Automatic:</strong> Huntarr.io will automatically update when new releases are available.</li>
|
||||
<li><strong>Notify Only:</strong> You'll be notified about updates but they won't be installed automatically.</li>
|
||||
<li><strong>Disabled:</strong> No update checks will be performed.</li>
|
||||
</ul>
|
||||
|
||||
<h2>Backup</h2>
|
||||
|
||||
<h3>Backup Location</h3>
|
||||
<p>Specify where backups should be stored. Default location is <code>/opt/appdata/huntarr/backups</code>, but you can change this to any accessible path.</p>
|
||||
|
||||
<h3>Backup Schedule</h3>
|
||||
<p>Configure automatic backups of your Huntarr.io configuration:</p>
|
||||
<ul>
|
||||
<li><strong>Daily:</strong> Run backups every day (recommended)</li>
|
||||
<li><strong>Weekly:</strong> Run backups once per week</li>
|
||||
<li><strong>Monthly:</strong> Run backups once per month</li>
|
||||
<li><strong>Disabled:</strong> Don't run automatic backups</li>
|
||||
</ul>
|
||||
|
||||
<h3>Backup Retention</h3>
|
||||
<p>Determine how many backups to keep before deleting older ones:</p>
|
||||
<ul>
|
||||
<li>Default: 7 backups</li>
|
||||
<li>Range: 1-30 backups</li>
|
||||
</ul>
|
||||
|
||||
<h2>Logging</h2>
|
||||
|
||||
<h3>Log Level</h3>
|
||||
<p>Select how detailed the logs should be:</p>
|
||||
<ul>
|
||||
<li><strong>Error:</strong> Only log errors</li>
|
||||
<li><strong>Warning:</strong> Log errors and warnings</li>
|
||||
<li><strong>Info:</strong> Default, includes general operation information</li>
|
||||
<li><strong>Debug:</strong> Detailed logs, useful for troubleshooting but generates larger log files</li>
|
||||
<li><strong>Trace:</strong> Most detailed logging level, should only be used when debugging issues</li>
|
||||
</ul>
|
||||
|
||||
<h3>Log Rotation</h3>
|
||||
<p>Configure when logs should be rotated:</p>
|
||||
<ul>
|
||||
<li><strong>Size:</strong> When log file reaches a certain size (default: 10MB)</li>
|
||||
<li><strong>Daily:</strong> Rotate logs once per day</li>
|
||||
<li><strong>Weekly:</strong> Rotate logs once per week</li>
|
||||
</ul>
|
||||
|
||||
<h3>Log Retention</h3>
|
||||
<p>How many log files to keep before deleting older ones:</p>
|
||||
<ul>
|
||||
<li>Default: 10 files</li>
|
||||
<li>Range: 1-50 files</li>
|
||||
</ul>
|
||||
|
||||
<div class="section-nav">
|
||||
<a href="index.html">← Back to Settings</a>
|
||||
<a href="network.html">Network Settings →</a>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
Huntarr.io v6.5.18 | General Settings Documentation | Thanks 4 Using Huntarr - Admin9705
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
80
docs/settings/index.html
Normal file
80
docs/settings/index.html
Normal file
@@ -0,0 +1,80 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Huntarr.io Settings Documentation</title>
|
||||
<link rel="stylesheet" href="../css/main.css">
|
||||
<script src="../js/main.js" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<h1>Huntarr.io Settings</h1>
|
||||
|
||||
<div class="nav-menu">
|
||||
<ul>
|
||||
<li><a href="../index.html">Home</a></li>
|
||||
<li><a href="../apps/index.html">Apps</a></li>
|
||||
<li class="active"><a href="index.html">Settings</a></li>
|
||||
<li><a href="https://github.com/plexguide/Huntarr.io" target="_blank">GitHub</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<p>This section provides detailed documentation for all Huntarr.io settings and configuration options to help you optimize your media management experience.</p>
|
||||
|
||||
<h2>Settings Categories</h2>
|
||||
|
||||
<div class="app-box sonarr">
|
||||
<h3><a href="general.html">General Settings</a></h3>
|
||||
<p>Basic configuration options including server settings, update options, and user interface preferences.</p>
|
||||
<p><a href="general.html">View General Settings Documentation</a></p>
|
||||
</div>
|
||||
|
||||
<div class="app-box radarr">
|
||||
<h3><a href="network.html">Network Settings</a></h3>
|
||||
<p>Configure network-related settings including port configuration, SSL options, and proxy settings.</p>
|
||||
<p><a href="network.html">View Network Settings Documentation</a></p>
|
||||
</div>
|
||||
|
||||
<div class="app-box lidarr">
|
||||
<h3><a href="storage.html">Storage Settings</a></h3>
|
||||
<p>Configure storage paths, mount points, and disk management options for your media files.</p>
|
||||
<p><a href="storage.html">View Storage Settings Documentation</a></p>
|
||||
</div>
|
||||
|
||||
<div class="app-box readarr">
|
||||
<h3><a href="security.html">Security Settings</a></h3>
|
||||
<p>Configure authentication, user accounts, and access controls for your Huntarr.io instance.</p>
|
||||
<p><a href="security.html">View Security Settings Documentation</a></p>
|
||||
</div>
|
||||
|
||||
<div class="app-box whisparr">
|
||||
<h3><a href="integration.html">Integration Settings</a></h3>
|
||||
<p>Configure integrations with other services like Plex, Jellyfin, Emby, and notification systems.</p>
|
||||
<p><a href="integration.html">View Integration Settings Documentation</a></p>
|
||||
</div>
|
||||
|
||||
<h2>Adding (i) Links to Your Huntarr.io UI</h2>
|
||||
|
||||
<p>The information icon (<span class="info-link">i</span>) in the Huntarr.io user interface can be used to link directly to these documentation pages. When implementing the (i) links in your app's HTML, use the following format:</p>
|
||||
|
||||
<pre><code><a href="https://plexguide.github.io/Huntarr.io/apps/sonarr.html" class="info-link" target="_blank">i</a></code></pre>
|
||||
|
||||
<p>You can link to specific documentation pages by changing the URL path accordingly:</p>
|
||||
|
||||
<ul>
|
||||
<li>For app-specific pages: <code>/apps/[app-name].html</code> (e.g., <code>/apps/sonarr.html</code>)</li>
|
||||
<li>For settings pages: <code>/settings/[settings-category].html</code> (e.g., <code>/settings/network.html</code>)</li>
|
||||
</ul>
|
||||
|
||||
<div class="section-nav">
|
||||
<a href="../apps/index.html">← Applications Documentation</a>
|
||||
<a href="../index.html">Back to Home →</a>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
Huntarr.io v6.5.18 | Settings Documentation | Thanks 4 Using Huntarr - Admin9705
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user