mirror/AudioBookRequest
1
0
Fork 0
mirror of https://github.com/markbeep/AudioBookRequest.git synced 2026-01-24 07:00:02 -06:00
Code Issues Packages Projects Releases Wiki Activity

deploy: 9b2cda30c0

Browse Source
This commit is contained in:
markbeep
2025-08-22 13:02:33 +00:00
parent 3a6b31996b
commit ea588648f9
47 changed files with 845 additions and 205 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
categories/development/index.html
View File

@@ -29,7 +29,7 @@
<meta itemprop="name" content="Development">
<meta itemprop="description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Development">
<meta name="twitter:description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">

2
categories/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Categories">
<meta itemprop="description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">
<meta itemprop="datePublished" content="2025-06-09T13:03:35+02:00">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Categories">
<meta name="twitter:description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">

2
categories/index.xml
View File

@@ -6,7 +6,7 @@
<description>Recent content in Categories on AudioBookRequest Docs</description>
<generator>Hugo</generator>
<language>en</language>
<lastBuildDate>Sat, 16 Aug 2025 11:20:34 +0200</lastBuildDate>
<lastBuildDate>Fri, 22 Aug 2025 15:01:53 +0200</lastBuildDate>
<atom:link href="https://markbeep.github.io/AudioBookRequest/categories/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Setup</title>

2
categories/setup/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Setup">
<meta itemprop="description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">
<meta itemprop="datePublished" content="2025-06-09T13:03:35+02:00">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Setup">
<meta name="twitter:description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">

2
categories/setup/index.xml
View File

@@ -6,7 +6,7 @@
<description>Recent content in Setup on AudioBookRequest Docs</description>
<generator>Hugo</generator>
<language>en</language>
<lastBuildDate>Sat, 16 Aug 2025 11:20:34 +0200</lastBuildDate>
<lastBuildDate>Fri, 22 Aug 2025 15:01:53 +0200</lastBuildDate>
<atom:link href="https://markbeep.github.io/AudioBookRequest/categories/setup/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Docker</title>

2
community/_print/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Community">
<meta itemprop="description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Community">
<meta name="twitter:description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">

2
community/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Community">
<meta itemprop="description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Community">
<meta name="twitter:description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">

97
docs/_print/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Documentation">
<meta itemprop="description" content="Welcome to the documentation for AudioBookRequest.">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="245">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Documentation">
@@ -290,6 +290,14 @@ This is the multi-page printable view of this section.
<li>2.2.1: <a href="#pg-3e4cf7e150c25ad9c46b6de4e314451e">Indexers</a></li>
</ul>
@@ -839,42 +847,28 @@ one of the following pages:</p>
<h1 id="pg-eb0b8b2f51c3e22c9b2de4770486ca52">2.2 - API</h1>
<div class="lead">How to use the AudioBookRequest API</div>
<h2 id="overview">Overview<a class="td-heading-self-link" href="#overview" aria-label="Heading self-link"></a></h2>
<p>AudioBookRequest provides a RESTful API for managing users and audiobook requests. The API uses Bearer token authentication with API keys that can be generated through the web interface.</p>
<p>AudioBookRequest provides a RESTful API for a select few endpoints.</p>
<p>The API uses Bearer token authentication with API keys that can be generated
through the web interface.</p>
<h2 id="how-to-create-an-api-key">How to Create an API Key<a class="td-heading-self-link" href="#how-to-create-an-api-key" aria-label="Heading self-link"></a></h2>
<p>Follow these steps to create an API key for accessing the AudioBookRequest API:</p>
<h3 id="step-1-access-the-web-interface">Step 1: Access the Web Interface<a class="td-heading-self-link" href="#step-1-access-the-web-interface" aria-label="Heading self-link"></a></h3>
<ol>
<li>Open your web browser and navigate to your AudioBookRequest instance</li>
<li>Log in with your username and password</li>
</ol>
<h3 id="step-2-navigate-to-account-settings">Step 2: Navigate to Account Settings<a class="td-heading-self-link" href="#step-2-navigate-to-account-settings" aria-label="Heading self-link"></a></h3>
<ol>
<li>Once logged in, click on the <strong>Settings</strong> menu</li>
<li>Select <strong>Account</strong> from the settings options</li>
</ol>
<h3 id="step-3-create-a-new-api-key">Step 3: Create a New API Key<a class="td-heading-self-link" href="#step-3-create-a-new-api-key" aria-label="Heading self-link"></a></h3>
<ol>
<li>In the Account settings page, look for the <strong>API Keys</strong> section</li>
<li>Click on <strong>Create New API Key</strong> or similar button</li>
<li>Enter a descriptive name for your API key (e.g., &ldquo;Mobile App&rdquo;, &ldquo;Automation Script&rdquo;, &ldquo;Home Assistant Integration&rdquo;)</li>
<li>Click <strong>Generate</strong> or <strong>Create</strong></li>
</ol>
<h3 id="step-4-copy-and-store-your-api-key">Step 4: Copy and Store Your API Key<a class="td-heading-self-link" href="#step-4-copy-and-store-your-api-key" aria-label="Heading self-link"></a></h3>
<ol>
<li>Enter a unique name for your API key</li>
<li>Click on <strong>Create API Key</strong></li>
<li><strong>Important</strong>: The API key will only be displayed once for security reasons</li>
<li>Copy the generated API key immediately and store it in a secure location</li>
<li>If you lose the key, you&rsquo;ll need to generate a new one</li>
</ol>
<h3 id="step-5-use-your-api-key">Step 5: Use Your API Key<a class="td-heading-self-link" href="#step-5-use-your-api-key" aria-label="Heading self-link"></a></h3>
<h3 id="use-your-api-key">Use Your API Key<a class="td-heading-self-link" href="#use-your-api-key" aria-label="Heading self-link"></a></h3>
<p>Include your API key in the Authorization header of your API requests:</p>
<pre tabindex="0"><code>Authorization: Bearer &lt;your-api-key&gt;
</code></pre><p><strong>Example using cURL:</strong></p>
<div class="highlight"><pre tabindex="0" style="color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>curl -H <span style="color:#63c381">&#34;Authorization: Bearer your-api-key-here&#34;</span> <span style="color:#d26464;font-weight:bold">\
</span></span></span><span style="display:flex;"><span><span style="color:#d26464;font-weight:bold"></span> http://localhost:8000/api/users/me
<div class="highlight"><pre tabindex="0" style="color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>curl -H <span style="color:#63c381">&#34;Authorization: Bearer &lt;your-api-key-here&gt;&#34;</span> https://abr.example.com/api/users/me
</span></span></code></pre></div><h2 id="api-documentation">API Documentation<a class="td-heading-self-link" href="#api-documentation" aria-label="Heading self-link"></a></h2>
<p>For a SwaggerUI documentation with interactive testing capabilities:</p>
<ol>
<li>Set the environment variable <code>ABR_OPENAPI_ENABLED=true</code></li>
<li>Set the environment variable <code>ABR_APP__OPENAPI_ENABLED=true</code></li>
<li>Head to <code>&lt;your-domain&gt;/docs</code>.</li>
</ol>
@@ -893,6 +887,63 @@ one of the following pages:</p>
<div class="td-content" style="page-break-before: always">
<h1 id="pg-3e4cf7e150c25ad9c46b6de4e314451e">2.2.1 - Indexers</h1>
<div class="lead">Using the API to access/update indexers</div>
<p>There are two main endpoints to work with indexers:</p>
<ul>
<li>A <code>PATCH</code> to update indexer settings.</li>
<li>A <code>GET</code> to get all the available configuration settings for the indexers.</li>
</ul>
<p>Head to the main <a href="/AudioBookRequest/docs/tutorials/api/">API Docs</a> to see how you can access the SwaggerUI
and more easily test the endpoints.</p>
<h2 id="getting-the-indexer-configurations">Getting the Indexer Configurations<a class="td-heading-self-link" href="#getting-the-indexer-configurations" aria-label="Heading self-link"></a></h2>
<p>To figure out what values you need to adjust, <code>GET</code> the endpoint
<code>/api/indexers/configurations</code>.</p>
<p>This will give you something along the lines of this:</p>
<div class="highlight"><pre tabindex="0" style="color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;MyAnonamouse&#34;</span>: [
</span></span><span style="display:flex;"><span> {
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;name&#34;</span>: <span style="color:#63c381">&#34;mam_session_id&#34;</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;description&#34;</span>: <span style="color:#b756ff;font-weight:bold">null</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;default&#34;</span>: <span style="color:#b756ff;font-weight:bold">null</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;required&#34;</span>: <span style="color:#b756ff;font-weight:bold">true</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;type&#34;</span>: <span style="color:#63c381">&#34;str&#34;</span>
</span></span><span style="display:flex;"><span> },
</span></span><span style="display:flex;"><span> {
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;name&#34;</span>: <span style="color:#63c381">&#34;mam_active&#34;</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;description&#34;</span>: <span style="color:#b756ff;font-weight:bold">null</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;default&#34;</span>: <span style="color:#63c381">&#34;True&#34;</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;required&#34;</span>: <span style="color:#b756ff;font-weight:bold">false</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;type&#34;</span>: <span style="color:#63c381">&#34;bool&#34;</span>
</span></span><span style="display:flex;"><span> }
</span></span><span style="display:flex;"><span> ]
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p>This gives you the full information about what values can be adjusted.</p>
<h2 id="updating-indexer-settings">Updating Indexer Settings<a class="td-heading-self-link" href="#updating-indexer-settings" aria-label="Heading self-link"></a></h2>
<p>You can update indexer settings by sending a <code>PATCH</code> request to
<code>/api/indexers/{indexer name}</code>. The name is <strong>case-sensitive</strong>. The body has to
be a JSON object with key-value pairs of the values you want to update.</p>
<p>Here is an example using cURL: as</p>
<div class="highlight"><pre tabindex="0" style="color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>curl -X <span style="color:#98c379">&#39;PATCH&#39;</span> <span style="color:#d26464;font-weight:bold">\
</span></span></span><span style="display:flex;"><span><span style="color:#d26464;font-weight:bold"></span> <span style="color:#98c379">&#39;https://abr.example.com/api/indexers/MyAnonamouse&#39;</span> <span style="color:#d26464;font-weight:bold">\
</span></span></span><span style="display:flex;"><span><span style="color:#d26464;font-weight:bold"></span> -H <span style="color:#98c379">&#39;accept: application/json&#39;</span> <span style="color:#d26464;font-weight:bold">\
</span></span></span><span style="display:flex;"><span><span style="color:#d26464;font-weight:bold"></span> -H <span style="color:#98c379">&#39;Authorization: Bearer MaEqMYAGY3qvXxtje6-YDxcs4damlyRaKzTC8itG2b8&#39;</span> <span style="color:#d26464;font-weight:bold">\
</span></span></span><span style="display:flex;"><span><span style="color:#d26464;font-weight:bold"></span> -d <span style="color:#98c379">&#39;{&#34;mam_session_id&#34;:&#34;bXDv1tC1d2MVvOypbFy8Q4Q-rz6q-bKwdqaSZzm85Dg&#34;}&#39;</span>
</span></span></code></pre></div>
</div>

2
docs/concepts/_print/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Concepts">
<meta itemprop="description" content="Concepts used in ABR in more detail.">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Concepts">
<meta name="twitter:description" content="Concepts used in ABR in more detail.">

13
docs/concepts/environment-variables/index.html
View File

@@ -27,12 +27,12 @@
<meta property="og:type" content="article">
<meta property="article:section" content="docs">
<meta property="article:published_time" content="2025-06-09T13:46:33+02:00">
<meta property="article:modified_time" content="2025-08-16T11:20:34+02:00">
<meta property="article:modified_time" content="2025-08-22T15:01:53+02:00">
<meta itemprop="name" content="Environment Variables">
<meta itemprop="description" content="List of the environment variables that can be set.">
<meta itemprop="datePublished" content="2025-06-09T13:46:33+02:00">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="255">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Environment Variables">
@@ -162,8 +162,13 @@
<ul class="ul-2 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsnotifications-li">
<a href="/AudioBookRequest/docs/tutorials/notifications/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsnotifications"><span class="">Notifications</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapi-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-audiobookrequestdocstutorialsapi-li">
<a href="/AudioBookRequest/docs/tutorials/api/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsapi"><span class="">API</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapiindexers-li">
<a href="/AudioBookRequest/docs/tutorials/api/indexers/" class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id="m-audiobookrequestdocstutorialsapiindexers"><span class="">Indexers</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsoidc-li">
<a href="/AudioBookRequest/docs/tutorials/oidc/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsoidc"><span class="">OpenID Connect</span></a>
</li>
@@ -372,7 +377,7 @@ and second part of each environment variable like between <code>ABR_APP</code> a
</script>
<br />
<div class="td-page-meta__lastmod">
Last modified August 16, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/93a6315e304a829506136e90fde2f98af71625f9">feat: added env variables for forcing login type and initializing username/password (93a6315)</a>
Last modified August 22, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f">feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)</a>
</div>
</div>

11
docs/concepts/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Concepts">
<meta itemprop="description" content="Concepts used in ABR in more detail.">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Concepts">
<meta name="twitter:description" content="Concepts used in ABR in more detail.">
@@ -159,8 +159,13 @@
<ul class="ul-2 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsnotifications-li">
<a href="/AudioBookRequest/docs/tutorials/notifications/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsnotifications"><span class="">Notifications</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapi-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-audiobookrequestdocstutorialsapi-li">
<a href="/AudioBookRequest/docs/tutorials/api/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsapi"><span class="">API</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapiindexers-li">
<a href="/AudioBookRequest/docs/tutorials/api/indexers/" class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id="m-audiobookrequestdocstutorialsapiindexers"><span class="">Indexers</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsoidc-li">
<a href="/AudioBookRequest/docs/tutorials/oidc/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsoidc"><span class="">OpenID Connect</span></a>
</li>
@@ -302,7 +307,7 @@
</script>
<br />
<div class="td-page-meta__lastmod">
Last modified August 16, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/93a6315e304a829506136e90fde2f98af71625f9">feat: added env variables for forcing login type and initializing username/password (93a6315)</a>
Last modified August 22, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f">feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)</a>
</div>
</div>

13
docs/contribution-guidelines/index.html
View File

@@ -26,11 +26,11 @@
<meta property="og:locale" content="en">
<meta property="og:type" content="article">
<meta property="article:section" content="docs">
<meta property="article:modified_time" content="2025-08-16T11:20:34+02:00">
<meta property="article:modified_time" content="2025-08-22T15:01:53+02:00">
<meta itemprop="name" content="Contribution Guidelines">
<meta itemprop="description" content="How to contribute to the docs.">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="546">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Contribution Guidelines">
@@ -160,8 +160,13 @@
<ul class="ul-2 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsnotifications-li">
<a href="/AudioBookRequest/docs/tutorials/notifications/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsnotifications"><span class="">Notifications</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapi-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-audiobookrequestdocstutorialsapi-li">
<a href="/AudioBookRequest/docs/tutorials/api/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsapi"><span class="">API</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapiindexers-li">
<a href="/AudioBookRequest/docs/tutorials/api/indexers/" class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id="m-audiobookrequestdocstutorialsapiindexers"><span class="">Indexers</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsoidc-li">
<a href="/AudioBookRequest/docs/tutorials/oidc/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsoidc"><span class="">OpenID Connect</span></a>
</li>
@@ -383,7 +388,7 @@ basic introduction to GitHub concepts and workflow.</li>
</script>
<br />
<div class="td-page-meta__lastmod">
Last modified August 16, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/93a6315e304a829506136e90fde2f98af71625f9">feat: added env variables for forcing login type and initializing username/password (93a6315)</a>
Last modified August 22, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f">feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)</a>
</div>
</div>

2
docs/getting-started/_print/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Getting Started">
<meta itemprop="description" content="What does your user need to know to try your project?">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="65">
<meta itemprop="keywords" content="Setup">
<meta name="twitter:card" content="summary">

2
docs/getting-started/first-login/_print/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="First Login">
<meta itemprop="description" content="Logging in the first time">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="234">
<meta itemprop="keywords" content="Setup">
<meta name="twitter:card" content="summary">

11
docs/getting-started/first-login/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="First Login">
<meta itemprop="description" content="Logging in the first time">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="234">
<meta itemprop="keywords" content="Setup">
<meta name="twitter:card" content="summary">
@@ -161,8 +161,13 @@
<ul class="ul-2 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsnotifications-li">
<a href="/AudioBookRequest/docs/tutorials/notifications/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsnotifications"><span class="">Notifications</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapi-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-audiobookrequestdocstutorialsapi-li">
<a href="/AudioBookRequest/docs/tutorials/api/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsapi"><span class="">API</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapiindexers-li">
<a href="/AudioBookRequest/docs/tutorials/api/indexers/" class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id="m-audiobookrequestdocstutorialsapiindexers"><span class="">Indexers</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsoidc-li">
<a href="/AudioBookRequest/docs/tutorials/oidc/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsoidc"><span class="">OpenID Connect</span></a>
</li>
@@ -347,7 +352,7 @@ login type.
</script>
<br />
<div class="td-page-meta__lastmod">
Last modified August 16, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/93a6315e304a829506136e90fde2f98af71625f9">feat: added env variables for forcing login type and initializing username/password (93a6315)</a>
Last modified August 22, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f">feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)</a>
</div>
</div>

11
docs/getting-started/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Getting Started">
<meta itemprop="description" content="What does your user need to know to try your project?">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="65">
<meta itemprop="keywords" content="Setup">
<meta name="twitter:card" content="summary">
@@ -161,8 +161,13 @@
<ul class="ul-2 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsnotifications-li">
<a href="/AudioBookRequest/docs/tutorials/notifications/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsnotifications"><span class="">Notifications</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapi-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-audiobookrequestdocstutorialsapi-li">
<a href="/AudioBookRequest/docs/tutorials/api/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsapi"><span class="">API</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapiindexers-li">
<a href="/AudioBookRequest/docs/tutorials/api/indexers/" class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id="m-audiobookrequestdocstutorialsapiindexers"><span class="">Indexers</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsoidc-li">
<a href="/AudioBookRequest/docs/tutorials/oidc/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsoidc"><span class="">OpenID Connect</span></a>
</li>
@@ -331,7 +336,7 @@ local development, as a lot of things can change from version to version.</p>
</script>
<br />
<div class="td-page-meta__lastmod">
Last modified August 16, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/93a6315e304a829506136e90fde2f98af71625f9">feat: added env variables for forcing login type and initializing username/password (93a6315)</a>
Last modified August 22, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f">feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)</a>
</div>
</div>

2
docs/getting-started/running-the-app/_print/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Running the app">
<meta itemprop="description" content="Getting AudioBookRequest up and running.">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="52">
<meta itemprop="keywords" content="Setup">
<meta name="twitter:card" content="summary">

13
docs/getting-started/running-the-app/bare-metal/index.html
View File

@@ -27,13 +27,13 @@
<meta property="og:type" content="article">
<meta property="article:section" content="docs">
<meta property="article:published_time" content="2025-06-09T13:03:35+02:00">
<meta property="article:modified_time" content="2025-08-16T11:20:34+02:00">
<meta property="article:modified_time" content="2025-08-22T15:01:53+02:00">
<meta property="article:tag" content="Development">
<meta itemprop="name" content="Bare Metal">
<meta itemprop="description" content="How to get started **without** Docker.">
<meta itemprop="datePublished" content="2025-06-09T13:03:35+02:00">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="223">
<meta itemprop="keywords" content="Development">
<meta name="twitter:card" content="summary">
@@ -164,8 +164,13 @@
<ul class="ul-2 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsnotifications-li">
<a href="/AudioBookRequest/docs/tutorials/notifications/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsnotifications"><span class="">Notifications</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapi-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-audiobookrequestdocstutorialsapi-li">
<a href="/AudioBookRequest/docs/tutorials/api/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsapi"><span class="">API</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapiindexers-li">
<a href="/AudioBookRequest/docs/tutorials/api/indexers/" class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id="m-audiobookrequestdocstutorialsapiindexers"><span class="">Indexers</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsoidc-li">
<a href="/AudioBookRequest/docs/tutorials/oidc/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsoidc"><span class="">OpenID Connect</span></a>
</li>
@@ -347,7 +352,7 @@ set in there.</li>
</script>
<br />
<div class="td-page-meta__lastmod">
Last modified August 16, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/93a6315e304a829506136e90fde2f98af71625f9">feat: added env variables for forcing login type and initializing username/password (93a6315)</a>
Last modified August 22, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f">feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)</a>
</div>
</div>

13
docs/getting-started/running-the-app/docker-compose/index.html
View File

@@ -27,13 +27,13 @@
<meta property="og:type" content="article">
<meta property="article:section" content="docs">
<meta property="article:published_time" content="2025-06-09T13:03:35+02:00">
<meta property="article:modified_time" content="2025-08-16T11:20:34+02:00">
<meta property="article:modified_time" content="2025-08-22T15:01:53+02:00">
<meta property="article:tag" content="Docker">
<meta itemprop="name" content="Docker Compose">
<meta itemprop="description" content="How to get started using Docker-Compose.">
<meta itemprop="datePublished" content="2025-06-09T13:03:35+02:00">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="63">
<meta itemprop="keywords" content="Docker">
<meta name="twitter:card" content="summary">
@@ -164,8 +164,13 @@
<ul class="ul-2 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsnotifications-li">
<a href="/AudioBookRequest/docs/tutorials/notifications/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsnotifications"><span class="">Notifications</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapi-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-audiobookrequestdocstutorialsapi-li">
<a href="/AudioBookRequest/docs/tutorials/api/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsapi"><span class="">API</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapiindexers-li">
<a href="/AudioBookRequest/docs/tutorials/api/indexers/" class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id="m-audiobookrequestdocstutorialsapiindexers"><span class="">Indexers</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsoidc-li">
<a href="/AudioBookRequest/docs/tutorials/oidc/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsoidc"><span class="">OpenID Connect</span></a>
</li>
@@ -334,7 +339,7 @@ It would look along the lines of this:</p>
</script>
<br />
<div class="td-page-meta__lastmod">
Last modified August 16, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/93a6315e304a829506136e90fde2f98af71625f9">feat: added env variables for forcing login type and initializing username/password (93a6315)</a>
Last modified August 22, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f">feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)</a>
</div>
</div>

13
docs/getting-started/running-the-app/docker/index.html
View File

@@ -27,13 +27,13 @@
<meta property="og:type" content="article">
<meta property="article:section" content="docs">
<meta property="article:published_time" content="2025-06-09T13:03:35+02:00">
<meta property="article:modified_time" content="2025-08-16T11:20:34+02:00">
<meta property="article:modified_time" content="2025-08-22T15:01:53+02:00">
<meta property="article:tag" content="Docker">
<meta itemprop="name" content="Docker">
<meta itemprop="description" content="How to get started using Docker.">
<meta itemprop="datePublished" content="2025-06-09T13:03:35+02:00">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="124">
<meta itemprop="keywords" content="Docker">
<meta name="twitter:card" content="summary">
@@ -164,8 +164,13 @@
<ul class="ul-2 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsnotifications-li">
<a href="/AudioBookRequest/docs/tutorials/notifications/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsnotifications"><span class="">Notifications</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapi-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-audiobookrequestdocstutorialsapi-li">
<a href="/AudioBookRequest/docs/tutorials/api/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsapi"><span class="">API</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapiindexers-li">
<a href="/AudioBookRequest/docs/tutorials/api/indexers/" class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id="m-audiobookrequestdocstutorialsapiindexers"><span class="">Indexers</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsoidc-li">
<a href="/AudioBookRequest/docs/tutorials/oidc/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsoidc"><span class="">OpenID Connect</span></a>
</li>
@@ -336,7 +341,7 @@ the <code>:nightly</code> version tag can be used.</p>
</script>
<br />
<div class="td-page-meta__lastmod">
Last modified August 16, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/93a6315e304a829506136e90fde2f98af71625f9">feat: added env variables for forcing login type and initializing username/password (93a6315)</a>
Last modified August 22, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f">feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)</a>
</div>
</div>

11
docs/getting-started/running-the-app/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Running the app">
<meta itemprop="description" content="Getting AudioBookRequest up and running.">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="52">
<meta itemprop="keywords" content="Setup">
<meta name="twitter:card" content="summary">
@@ -161,8 +161,13 @@
<ul class="ul-2 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsnotifications-li">
<a href="/AudioBookRequest/docs/tutorials/notifications/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsnotifications"><span class="">Notifications</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapi-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-audiobookrequestdocstutorialsapi-li">
<a href="/AudioBookRequest/docs/tutorials/api/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsapi"><span class="">API</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapiindexers-li">
<a href="/AudioBookRequest/docs/tutorials/api/indexers/" class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id="m-audiobookrequestdocstutorialsapiindexers"><span class="">Indexers</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsoidc-li">
<a href="/AudioBookRequest/docs/tutorials/oidc/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsoidc"><span class="">OpenID Connect</span></a>
</li>
@@ -335,7 +340,7 @@ different ways.</p>
</script>
<br />
<div class="td-page-meta__lastmod">
Last modified August 16, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/93a6315e304a829506136e90fde2f98af71625f9">feat: added env variables for forcing login type and initializing username/password (93a6315)</a>
Last modified August 22, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f">feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)</a>
</div>
</div>

13
docs/getting-started/running-the-app/kubernetes/index.html
View File

@@ -27,13 +27,13 @@
<meta property="og:type" content="article">
<meta property="article:section" content="docs">
<meta property="article:published_time" content="2025-06-09T13:03:35+02:00">
<meta property="article:modified_time" content="2025-08-16T11:20:34+02:00">
<meta property="article:modified_time" content="2025-08-22T15:01:53+02:00">
<meta property="article:tag" content="Docker">
<meta itemprop="name" content="Kubernetes">
<meta itemprop="description" content="How to get started using Kubernetes.">
<meta itemprop="datePublished" content="2025-06-09T13:03:35+02:00">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="79">
<meta itemprop="keywords" content="Docker">
<meta name="twitter:card" content="summary">
@@ -164,8 +164,13 @@
<ul class="ul-2 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsnotifications-li">
<a href="/AudioBookRequest/docs/tutorials/notifications/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsnotifications"><span class="">Notifications</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapi-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-audiobookrequestdocstutorialsapi-li">
<a href="/AudioBookRequest/docs/tutorials/api/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsapi"><span class="">API</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapiindexers-li">
<a href="/AudioBookRequest/docs/tutorials/api/indexers/" class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id="m-audiobookrequestdocstutorialsapiindexers"><span class="">Indexers</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsoidc-li">
<a href="/AudioBookRequest/docs/tutorials/oidc/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsoidc"><span class="">OpenID Connect</span></a>
</li>
@@ -344,7 +349,7 @@
</script>
<br />
<div class="td-page-meta__lastmod">
Last modified August 16, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/93a6315e304a829506136e90fde2f98af71625f9">feat: added env variables for forcing login type and initializing username/password (93a6315)</a>
Last modified August 22, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f">feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)</a>
</div>
</div>

11
docs/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Documentation">
<meta itemprop="description" content="Welcome to the documentation for AudioBookRequest.">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="245">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Documentation">
@@ -160,8 +160,13 @@
<ul class="ul-2 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsnotifications-li">
<a href="/AudioBookRequest/docs/tutorials/notifications/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsnotifications"><span class="">Notifications</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapi-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-audiobookrequestdocstutorialsapi-li">
<a href="/AudioBookRequest/docs/tutorials/api/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsapi"><span class="">API</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapiindexers-li">
<a href="/AudioBookRequest/docs/tutorials/api/indexers/" class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id="m-audiobookrequestdocstutorialsapiindexers"><span class="">Indexers</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsoidc-li">
<a href="/AudioBookRequest/docs/tutorials/oidc/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsoidc"><span class="">OpenID Connect</span></a>
</li>
@@ -369,7 +374,7 @@ structure.</p>
</script>
<br />
<div class="td-page-meta__lastmod">
Last modified August 16, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/93a6315e304a829506136e90fde2f98af71625f9">feat: added env variables for forcing login type and initializing username/password (93a6315)</a>
Last modified August 22, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f">feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)</a>
</div>
</div>

2
docs/local-development/_print/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Local Development">
<meta itemprop="description" content="How to set up the project for local development.">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="354">
<meta itemprop="keywords" content="Local">
<meta name="twitter:card" content="summary">

11
docs/local-development/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Local Development">
<meta itemprop="description" content="How to set up the project for local development.">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="354">
<meta itemprop="keywords" content="Local">
<meta name="twitter:card" content="summary">
@@ -161,8 +161,13 @@
<ul class="ul-2 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsnotifications-li">
<a href="/AudioBookRequest/docs/tutorials/notifications/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsnotifications"><span class="">Notifications</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapi-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-audiobookrequestdocstutorialsapi-li">
<a href="/AudioBookRequest/docs/tutorials/api/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsapi"><span class="">API</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapiindexers-li">
<a href="/AudioBookRequest/docs/tutorials/api/indexers/" class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id="m-audiobookrequestdocstutorialsapiindexers"><span class="">Indexers</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsoidc-li">
<a href="/AudioBookRequest/docs/tutorials/oidc/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsoidc"><span class="">OpenID Connect</span></a>
</li>
@@ -377,7 +382,7 @@ only run if explicitly stated as follows:</p>
</script>
<br />
<div class="td-page-meta__lastmod">
Last modified August 16, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/93a6315e304a829506136e90fde2f98af71625f9">feat: added env variables for forcing login type and initializing username/password (93a6315)</a>
Last modified August 22, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f">feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)</a>
</div>
</div>

97
docs/tutorials/_print/index.html
View File

@@ -31,7 +31,7 @@
<meta itemprop="name" content="Tutorials">
<meta itemprop="description" content="Tutorials about how to setup certain features with more detail.">
<meta itemprop="datePublished" content="2025-06-09T13:47:04+02:00">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Tutorials">
<meta name="twitter:description" content="Tutorials about how to setup certain features with more detail.">
@@ -186,6 +186,14 @@ This is the multi-page printable view of this section.
<li>2.1: <a href="#pg-3e4cf7e150c25ad9c46b6de4e314451e">Indexers</a></li>
</ul>
@@ -295,42 +303,28 @@ one of the following pages:</p>
<h1 id="pg-eb0b8b2f51c3e22c9b2de4770486ca52">2 - API</h1>
<div class="lead">How to use the AudioBookRequest API</div>
<h2 id="overview">Overview<a class="td-heading-self-link" href="#overview" aria-label="Heading self-link"></a></h2>
<p>AudioBookRequest provides a RESTful API for managing users and audiobook requests. The API uses Bearer token authentication with API keys that can be generated through the web interface.</p>
<p>AudioBookRequest provides a RESTful API for a select few endpoints.</p>
<p>The API uses Bearer token authentication with API keys that can be generated
through the web interface.</p>
<h2 id="how-to-create-an-api-key">How to Create an API Key<a class="td-heading-self-link" href="#how-to-create-an-api-key" aria-label="Heading self-link"></a></h2>
<p>Follow these steps to create an API key for accessing the AudioBookRequest API:</p>
<h3 id="step-1-access-the-web-interface">Step 1: Access the Web Interface<a class="td-heading-self-link" href="#step-1-access-the-web-interface" aria-label="Heading self-link"></a></h3>
<ol>
<li>Open your web browser and navigate to your AudioBookRequest instance</li>
<li>Log in with your username and password</li>
</ol>
<h3 id="step-2-navigate-to-account-settings">Step 2: Navigate to Account Settings<a class="td-heading-self-link" href="#step-2-navigate-to-account-settings" aria-label="Heading self-link"></a></h3>
<ol>
<li>Once logged in, click on the <strong>Settings</strong> menu</li>
<li>Select <strong>Account</strong> from the settings options</li>
</ol>
<h3 id="step-3-create-a-new-api-key">Step 3: Create a New API Key<a class="td-heading-self-link" href="#step-3-create-a-new-api-key" aria-label="Heading self-link"></a></h3>
<ol>
<li>In the Account settings page, look for the <strong>API Keys</strong> section</li>
<li>Click on <strong>Create New API Key</strong> or similar button</li>
<li>Enter a descriptive name for your API key (e.g., &ldquo;Mobile App&rdquo;, &ldquo;Automation Script&rdquo;, &ldquo;Home Assistant Integration&rdquo;)</li>
<li>Click <strong>Generate</strong> or <strong>Create</strong></li>
</ol>
<h3 id="step-4-copy-and-store-your-api-key">Step 4: Copy and Store Your API Key<a class="td-heading-self-link" href="#step-4-copy-and-store-your-api-key" aria-label="Heading self-link"></a></h3>
<ol>
<li>Enter a unique name for your API key</li>
<li>Click on <strong>Create API Key</strong></li>
<li><strong>Important</strong>: The API key will only be displayed once for security reasons</li>
<li>Copy the generated API key immediately and store it in a secure location</li>
<li>If you lose the key, you&rsquo;ll need to generate a new one</li>
</ol>
<h3 id="step-5-use-your-api-key">Step 5: Use Your API Key<a class="td-heading-self-link" href="#step-5-use-your-api-key" aria-label="Heading self-link"></a></h3>
<h3 id="use-your-api-key">Use Your API Key<a class="td-heading-self-link" href="#use-your-api-key" aria-label="Heading self-link"></a></h3>
<p>Include your API key in the Authorization header of your API requests:</p>
<pre tabindex="0"><code>Authorization: Bearer &lt;your-api-key&gt;
</code></pre><p><strong>Example using cURL:</strong></p>
<div class="highlight"><pre tabindex="0" style="color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>curl -H <span style="color:#63c381">&#34;Authorization: Bearer your-api-key-here&#34;</span> <span style="color:#d26464;font-weight:bold">\
</span></span></span><span style="display:flex;"><span><span style="color:#d26464;font-weight:bold"></span> http://localhost:8000/api/users/me
<div class="highlight"><pre tabindex="0" style="color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>curl -H <span style="color:#63c381">&#34;Authorization: Bearer &lt;your-api-key-here&gt;&#34;</span> https://abr.example.com/api/users/me
</span></span></code></pre></div><h2 id="api-documentation">API Documentation<a class="td-heading-self-link" href="#api-documentation" aria-label="Heading self-link"></a></h2>
<p>For a SwaggerUI documentation with interactive testing capabilities:</p>
<ol>
<li>Set the environment variable <code>ABR_OPENAPI_ENABLED=true</code></li>
<li>Set the environment variable <code>ABR_APP__OPENAPI_ENABLED=true</code></li>
<li>Head to <code>&lt;your-domain&gt;/docs</code>.</li>
</ol>
@@ -349,6 +343,63 @@ one of the following pages:</p>
<div class="td-content" style="page-break-before: always">
<h1 id="pg-3e4cf7e150c25ad9c46b6de4e314451e">2.1 - Indexers</h1>
<div class="lead">Using the API to access/update indexers</div>
<p>There are two main endpoints to work with indexers:</p>
<ul>
<li>A <code>PATCH</code> to update indexer settings.</li>
<li>A <code>GET</code> to get all the available configuration settings for the indexers.</li>
</ul>
<p>Head to the main <a href="/AudioBookRequest/docs/tutorials/api/">API Docs</a> to see how you can access the SwaggerUI
and more easily test the endpoints.</p>
<h2 id="getting-the-indexer-configurations">Getting the Indexer Configurations<a class="td-heading-self-link" href="#getting-the-indexer-configurations" aria-label="Heading self-link"></a></h2>
<p>To figure out what values you need to adjust, <code>GET</code> the endpoint
<code>/api/indexers/configurations</code>.</p>
<p>This will give you something along the lines of this:</p>
<div class="highlight"><pre tabindex="0" style="color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;MyAnonamouse&#34;</span>: [
</span></span><span style="display:flex;"><span> {
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;name&#34;</span>: <span style="color:#63c381">&#34;mam_session_id&#34;</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;description&#34;</span>: <span style="color:#b756ff;font-weight:bold">null</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;default&#34;</span>: <span style="color:#b756ff;font-weight:bold">null</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;required&#34;</span>: <span style="color:#b756ff;font-weight:bold">true</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;type&#34;</span>: <span style="color:#63c381">&#34;str&#34;</span>
</span></span><span style="display:flex;"><span> },
</span></span><span style="display:flex;"><span> {
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;name&#34;</span>: <span style="color:#63c381">&#34;mam_active&#34;</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;description&#34;</span>: <span style="color:#b756ff;font-weight:bold">null</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;default&#34;</span>: <span style="color:#63c381">&#34;True&#34;</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;required&#34;</span>: <span style="color:#b756ff;font-weight:bold">false</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;type&#34;</span>: <span style="color:#63c381">&#34;bool&#34;</span>
</span></span><span style="display:flex;"><span> }
</span></span><span style="display:flex;"><span> ]
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p>This gives you the full information about what values can be adjusted.</p>
<h2 id="updating-indexer-settings">Updating Indexer Settings<a class="td-heading-self-link" href="#updating-indexer-settings" aria-label="Heading self-link"></a></h2>
<p>You can update indexer settings by sending a <code>PATCH</code> request to
<code>/api/indexers/{indexer name}</code>. The name is <strong>case-sensitive</strong>. The body has to
be a JSON object with key-value pairs of the values you want to update.</p>
<p>Here is an example using cURL: as</p>
<div class="highlight"><pre tabindex="0" style="color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>curl -X <span style="color:#98c379">&#39;PATCH&#39;</span> <span style="color:#d26464;font-weight:bold">\
</span></span></span><span style="display:flex;"><span><span style="color:#d26464;font-weight:bold"></span> <span style="color:#98c379">&#39;https://abr.example.com/api/indexers/MyAnonamouse&#39;</span> <span style="color:#d26464;font-weight:bold">\
</span></span></span><span style="display:flex;"><span><span style="color:#d26464;font-weight:bold"></span> -H <span style="color:#98c379">&#39;accept: application/json&#39;</span> <span style="color:#d26464;font-weight:bold">\
</span></span></span><span style="display:flex;"><span><span style="color:#d26464;font-weight:bold"></span> -H <span style="color:#98c379">&#39;Authorization: Bearer MaEqMYAGY3qvXxtje6-YDxcs4damlyRaKzTC8itG2b8&#39;</span> <span style="color:#d26464;font-weight:bold">\
</span></span></span><span style="display:flex;"><span><span style="color:#d26464;font-weight:bold"></span> -d <span style="color:#98c379">&#39;{&#34;mam_session_id&#34;:&#34;bXDv1tC1d2MVvOypbFy8Q4Q-rz6q-bKwdqaSZzm85Dg&#34;}&#39;</span>
</span></span></code></pre></div>
</div>

99
docs/tutorials/api/_print/index.html
View File

@@ -30,8 +30,8 @@
<meta itemprop="name" content="API">
<meta itemprop="description" content="How to use the AudioBookRequest API">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="wordCount" content="232">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="154">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="API">
<meta name="twitter:description" content="How to use the AudioBookRequest API">
@@ -152,48 +152,42 @@ This is the multi-page printable view of this section.
<li>1: <a href="#pg-3e4cf7e150c25ad9c46b6de4e314451e">Indexers</a></li>
</ul>
<div class="content">
<h2 id="overview">Overview<a class="td-heading-self-link" href="#overview" aria-label="Heading self-link"></a></h2>
<p>AudioBookRequest provides a RESTful API for managing users and audiobook requests. The API uses Bearer token authentication with API keys that can be generated through the web interface.</p>
<p>AudioBookRequest provides a RESTful API for a select few endpoints.</p>
<p>The API uses Bearer token authentication with API keys that can be generated
through the web interface.</p>
<h2 id="how-to-create-an-api-key">How to Create an API Key<a class="td-heading-self-link" href="#how-to-create-an-api-key" aria-label="Heading self-link"></a></h2>
<p>Follow these steps to create an API key for accessing the AudioBookRequest API:</p>
<h3 id="step-1-access-the-web-interface">Step 1: Access the Web Interface<a class="td-heading-self-link" href="#step-1-access-the-web-interface" aria-label="Heading self-link"></a></h3>
<ol>
<li>Open your web browser and navigate to your AudioBookRequest instance</li>
<li>Log in with your username and password</li>
</ol>
<h3 id="step-2-navigate-to-account-settings">Step 2: Navigate to Account Settings<a class="td-heading-self-link" href="#step-2-navigate-to-account-settings" aria-label="Heading self-link"></a></h3>
<ol>
<li>Once logged in, click on the <strong>Settings</strong> menu</li>
<li>Select <strong>Account</strong> from the settings options</li>
</ol>
<h3 id="step-3-create-a-new-api-key">Step 3: Create a New API Key<a class="td-heading-self-link" href="#step-3-create-a-new-api-key" aria-label="Heading self-link"></a></h3>
<ol>
<li>In the Account settings page, look for the <strong>API Keys</strong> section</li>
<li>Click on <strong>Create New API Key</strong> or similar button</li>
<li>Enter a descriptive name for your API key (e.g., &ldquo;Mobile App&rdquo;, &ldquo;Automation Script&rdquo;, &ldquo;Home Assistant Integration&rdquo;)</li>
<li>Click <strong>Generate</strong> or <strong>Create</strong></li>
</ol>
<h3 id="step-4-copy-and-store-your-api-key">Step 4: Copy and Store Your API Key<a class="td-heading-self-link" href="#step-4-copy-and-store-your-api-key" aria-label="Heading self-link"></a></h3>
<ol>
<li>Enter a unique name for your API key</li>
<li>Click on <strong>Create API Key</strong></li>
<li><strong>Important</strong>: The API key will only be displayed once for security reasons</li>
<li>Copy the generated API key immediately and store it in a secure location</li>
<li>If you lose the key, you&rsquo;ll need to generate a new one</li>
</ol>
<h3 id="step-5-use-your-api-key">Step 5: Use Your API Key<a class="td-heading-self-link" href="#step-5-use-your-api-key" aria-label="Heading self-link"></a></h3>
<h3 id="use-your-api-key">Use Your API Key<a class="td-heading-self-link" href="#use-your-api-key" aria-label="Heading self-link"></a></h3>
<p>Include your API key in the Authorization header of your API requests:</p>
<pre tabindex="0"><code>Authorization: Bearer &lt;your-api-key&gt;
</code></pre><p><strong>Example using cURL:</strong></p>
<div class="highlight"><pre tabindex="0" style="color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>curl -H <span style="color:#63c381">&#34;Authorization: Bearer your-api-key-here&#34;</span> <span style="color:#d26464;font-weight:bold">\
</span></span></span><span style="display:flex;"><span><span style="color:#d26464;font-weight:bold"></span> http://localhost:8000/api/users/me
<div class="highlight"><pre tabindex="0" style="color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>curl -H <span style="color:#63c381">&#34;Authorization: Bearer &lt;your-api-key-here&gt;&#34;</span> https://abr.example.com/api/users/me
</span></span></code></pre></div><h2 id="api-documentation">API Documentation<a class="td-heading-self-link" href="#api-documentation" aria-label="Heading self-link"></a></h2>
<p>For a SwaggerUI documentation with interactive testing capabilities:</p>
<ol>
<li>Set the environment variable <code>ABR_OPENAPI_ENABLED=true</code></li>
<li>Set the environment variable <code>ABR_APP__OPENAPI_ENABLED=true</code></li>
<li>Head to <code>&lt;your-domain&gt;/docs</code>.</li>
</ol>
@@ -210,6 +204,63 @@ This is the multi-page printable view of this section.
<div class="td-content" style="page-break-before: always">
<h1 id="pg-3e4cf7e150c25ad9c46b6de4e314451e">1 - Indexers</h1>
<div class="lead">Using the API to access/update indexers</div>
<p>There are two main endpoints to work with indexers:</p>
<ul>
<li>A <code>PATCH</code> to update indexer settings.</li>
<li>A <code>GET</code> to get all the available configuration settings for the indexers.</li>
</ul>
<p>Head to the main <a href="/AudioBookRequest/docs/tutorials/api/">API Docs</a> to see how you can access the SwaggerUI
and more easily test the endpoints.</p>
<h2 id="getting-the-indexer-configurations">Getting the Indexer Configurations<a class="td-heading-self-link" href="#getting-the-indexer-configurations" aria-label="Heading self-link"></a></h2>
<p>To figure out what values you need to adjust, <code>GET</code> the endpoint
<code>/api/indexers/configurations</code>.</p>
<p>This will give you something along the lines of this:</p>
<div class="highlight"><pre tabindex="0" style="color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;MyAnonamouse&#34;</span>: [
</span></span><span style="display:flex;"><span> {
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;name&#34;</span>: <span style="color:#63c381">&#34;mam_session_id&#34;</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;description&#34;</span>: <span style="color:#b756ff;font-weight:bold">null</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;default&#34;</span>: <span style="color:#b756ff;font-weight:bold">null</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;required&#34;</span>: <span style="color:#b756ff;font-weight:bold">true</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;type&#34;</span>: <span style="color:#63c381">&#34;str&#34;</span>
</span></span><span style="display:flex;"><span> },
</span></span><span style="display:flex;"><span> {
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;name&#34;</span>: <span style="color:#63c381">&#34;mam_active&#34;</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;description&#34;</span>: <span style="color:#b756ff;font-weight:bold">null</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;default&#34;</span>: <span style="color:#63c381">&#34;True&#34;</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;required&#34;</span>: <span style="color:#b756ff;font-weight:bold">false</span>,
</span></span><span style="display:flex;"><span> <span style="color:#e06c75">&#34;type&#34;</span>: <span style="color:#63c381">&#34;bool&#34;</span>
</span></span><span style="display:flex;"><span> }
</span></span><span style="display:flex;"><span> ]
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p>This gives you the full information about what values can be adjusted.</p>
<h2 id="updating-indexer-settings">Updating Indexer Settings<a class="td-heading-self-link" href="#updating-indexer-settings" aria-label="Heading self-link"></a></h2>
<p>You can update indexer settings by sending a <code>PATCH</code> request to
<code>/api/indexers/{indexer name}</code>. The name is <strong>case-sensitive</strong>. The body has to
be a JSON object with key-value pairs of the values you want to update.</p>
<p>Here is an example using cURL: as</p>
<div class="highlight"><pre tabindex="0" style="color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>curl -X <span style="color:#98c379">&#39;PATCH&#39;</span> <span style="color:#d26464;font-weight:bold">\
</span></span></span><span style="display:flex;"><span><span style="color:#d26464;font-weight:bold"></span> <span style="color:#98c379">&#39;https://abr.example.com/api/indexers/MyAnonamouse&#39;</span> <span style="color:#d26464;font-weight:bold">\
</span></span></span><span style="display:flex;"><span><span style="color:#d26464;font-weight:bold"></span> -H <span style="color:#98c379">&#39;accept: application/json&#39;</span> <span style="color:#d26464;font-weight:bold">\
</span></span></span><span style="display:flex;"><span><span style="color:#d26464;font-weight:bold"></span> -H <span style="color:#98c379">&#39;Authorization: Bearer MaEqMYAGY3qvXxtje6-YDxcs4damlyRaKzTC8itG2b8&#39;</span> <span style="color:#d26464;font-weight:bold">\
</span></span></span><span style="display:flex;"><span><span style="color:#d26464;font-weight:bold"></span> -d <span style="color:#98c379">&#39;{&#34;mam_session_id&#34;:&#34;bXDv1tC1d2MVvOypbFy8Q4Q-rz6q-bKwdqaSZzm85Dg&#34;}&#39;</span>
</span></span></code></pre></div>
</div>

58
docs/tutorials/api/index.html
View File

@@ -30,8 +30,8 @@
<meta itemprop="name" content="API">
<meta itemprop="description" content="How to use the AudioBookRequest API">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="wordCount" content="232">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="154">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="API">
<meta name="twitter:description" content="How to use the AudioBookRequest API">
@@ -160,8 +160,13 @@
<ul class="ul-2 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsnotifications-li">
<a href="/AudioBookRequest/docs/tutorials/notifications/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsnotifications"><span class="">Notifications</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child active-path" id="m-audiobookrequestdocstutorialsapi-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child active-path" id="m-audiobookrequestdocstutorialsapi-li">
<a href="/AudioBookRequest/docs/tutorials/api/" class="align-left ps-0 active td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsapi"><span class="td-sidebar-nav-active-item">API</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapiindexers-li">
<a href="/AudioBookRequest/docs/tutorials/api/indexers/" class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id="m-audiobookrequestdocstutorialsapiindexers"><span class="">Indexers</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsoidc-li">
<a href="/AudioBookRequest/docs/tutorials/oidc/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsoidc"><span class="">OpenID Connect</span></a>
</li>
@@ -202,11 +207,7 @@
<li><a href="#overview">Overview</a></li>
<li><a href="#how-to-create-an-api-key">How to Create an API Key</a>
<ul>
<li><a href="#step-1-access-the-web-interface">Step 1: Access the Web Interface</a></li>
<li><a href="#step-2-navigate-to-account-settings">Step 2: Navigate to Account Settings</a></li>
<li><a href="#step-3-create-a-new-api-key">Step 3: Create a New API Key</a></li>
<li><a href="#step-4-copy-and-store-your-api-key">Step 4: Copy and Store Your API Key</a></li>
<li><a href="#step-5-use-your-api-key">Step 5: Use Your API Key</a></li>
<li><a href="#use-your-api-key">Use Your API Key</a></li>
</ul>
</li>
<li><a href="#api-documentation">API Documentation</a></li>
@@ -254,49 +255,42 @@
</header>
<h2 id="overview">Overview<a class="td-heading-self-link" href="#overview" aria-label="Heading self-link"></a></h2>
<p>AudioBookRequest provides a RESTful API for managing users and audiobook requests. The API uses Bearer token authentication with API keys that can be generated through the web interface.</p>
<p>AudioBookRequest provides a RESTful API for a select few endpoints.</p>
<p>The API uses Bearer token authentication with API keys that can be generated
through the web interface.</p>
<h2 id="how-to-create-an-api-key">How to Create an API Key<a class="td-heading-self-link" href="#how-to-create-an-api-key" aria-label="Heading self-link"></a></h2>
<p>Follow these steps to create an API key for accessing the AudioBookRequest API:</p>
<h3 id="step-1-access-the-web-interface">Step 1: Access the Web Interface<a class="td-heading-self-link" href="#step-1-access-the-web-interface" aria-label="Heading self-link"></a></h3>
<ol>
<li>Open your web browser and navigate to your AudioBookRequest instance</li>
<li>Log in with your username and password</li>
</ol>
<h3 id="step-2-navigate-to-account-settings">Step 2: Navigate to Account Settings<a class="td-heading-self-link" href="#step-2-navigate-to-account-settings" aria-label="Heading self-link"></a></h3>
<ol>
<li>Once logged in, click on the <strong>Settings</strong> menu</li>
<li>Select <strong>Account</strong> from the settings options</li>
</ol>
<h3 id="step-3-create-a-new-api-key">Step 3: Create a New API Key<a class="td-heading-self-link" href="#step-3-create-a-new-api-key" aria-label="Heading self-link"></a></h3>
<ol>
<li>In the Account settings page, look for the <strong>API Keys</strong> section</li>
<li>Click on <strong>Create New API Key</strong> or similar button</li>
<li>Enter a descriptive name for your API key (e.g., &ldquo;Mobile App&rdquo;, &ldquo;Automation Script&rdquo;, &ldquo;Home Assistant Integration&rdquo;)</li>
<li>Click <strong>Generate</strong> or <strong>Create</strong></li>
</ol>
<h3 id="step-4-copy-and-store-your-api-key">Step 4: Copy and Store Your API Key<a class="td-heading-self-link" href="#step-4-copy-and-store-your-api-key" aria-label="Heading self-link"></a></h3>
<ol>
<li>Enter a unique name for your API key</li>
<li>Click on <strong>Create API Key</strong></li>
<li><strong>Important</strong>: The API key will only be displayed once for security reasons</li>
<li>Copy the generated API key immediately and store it in a secure location</li>
<li>If you lose the key, you&rsquo;ll need to generate a new one</li>
</ol>
<h3 id="step-5-use-your-api-key">Step 5: Use Your API Key<a class="td-heading-self-link" href="#step-5-use-your-api-key" aria-label="Heading self-link"></a></h3>
<h3 id="use-your-api-key">Use Your API Key<a class="td-heading-self-link" href="#use-your-api-key" aria-label="Heading self-link"></a></h3>
<p>Include your API key in the Authorization header of your API requests:</p>
<pre tabindex="0"><code>Authorization: Bearer &lt;your-api-key&gt;
</code></pre><p><strong>Example using cURL:</strong></p>
<div class="highlight"><pre tabindex="0" style="color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>curl -H <span style="color:#63c381">&#34;Authorization: Bearer your-api-key-here&#34;</span> <span style="color:#d26464;font-weight:bold">\
</span></span></span><span style="display:flex;"><span><span style="color:#d26464;font-weight:bold"></span> http://localhost:8000/api/users/me
<div class="highlight"><pre tabindex="0" style="color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>curl -H <span style="color:#63c381">&#34;Authorization: Bearer &lt;your-api-key-here&gt;&#34;</span> https://abr.example.com/api/users/me
</span></span></code></pre></div><h2 id="api-documentation">API Documentation<a class="td-heading-self-link" href="#api-documentation" aria-label="Heading self-link"></a></h2>
<p>For a SwaggerUI documentation with interactive testing capabilities:</p>
<ol>
<li>Set the environment variable <code>ABR_OPENAPI_ENABLED=true</code></li>
<li>Set the environment variable <code>ABR_APP__OPENAPI_ENABLED=true</code></li>
<li>Head to <code>&lt;your-domain&gt;/docs</code>.</li>
</ol>
<div class="section-index">
</div>
<hr class="panel-line">
<div class="entry">
<h5>
<a href="/AudioBookRequest/docs/tutorials/api/indexers/">Indexers</a>
</h5>
<p>Using the API to access/update indexers</p>
</div>
</div>
<style>
.feedback--answer {
display: inline-block;
@@ -354,7 +348,7 @@
</script>
<br />
<div class="td-page-meta__lastmod">
Last modified August 16, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/93a6315e304a829506136e90fde2f98af71625f9">feat: added env variables for forcing login type and initializing username/password (93a6315)</a>
Last modified August 22, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f">feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)</a>
</div>
</div>

7
docs/tutorials/api/index.xml
View File

@@ -7,5 +7,12 @@
<generator>Hugo</generator>
<language>en</language>
<atom:link href="https://markbeep.github.io/AudioBookRequest/docs/tutorials/api/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Indexers</title>
<link>https://markbeep.github.io/AudioBookRequest/docs/tutorials/api/indexers/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://markbeep.github.io/AudioBookRequest/docs/tutorials/api/indexers/</guid>
<description>&lt;p&gt;There are two main endpoints to work with indexers:&lt;/p&gt;&#xA;&lt;ul&gt;&#xA;&lt;li&gt;A &lt;code&gt;PATCH&lt;/code&gt; to update indexer settings.&lt;/li&gt;&#xA;&lt;li&gt;A &lt;code&gt;GET&lt;/code&gt; to get all the available configuration settings for the indexers.&lt;/li&gt;&#xA;&lt;/ul&gt;&#xA;&lt;p&gt;Head to the main &lt;a href=&#34;https://markbeep.github.io/AudioBookRequest/docs/tutorials/api/&#34;&gt;API Docs&lt;/a&gt; to see how you can access the SwaggerUI&#xA;and more easily test the endpoints.&lt;/p&gt;&#xA;&lt;h2 id=&#34;getting-the-indexer-configurations&#34;&gt;Getting the Indexer Configurations&lt;a class=&#34;td-heading-self-link&#34; href=&#34;#getting-the-indexer-configurations&#34; aria-label=&#34;Heading self-link&#34;&gt;&lt;/a&gt;&lt;/h2&gt;&#xA;&lt;p&gt;To figure out what values you need to adjust, &lt;code&gt;GET&lt;/code&gt; the endpoint&#xA;&lt;code&gt;/api/indexers/configurations&lt;/code&gt;.&lt;/p&gt;&#xA;&lt;p&gt;This will give you something along the lines of this:&lt;/p&gt;</description>
</item>
</channel>
</rss>

401
docs/tutorials/api/indexers/index.html Normal file
View File

File diff suppressed because one or more lines are too long

11
docs/tutorials/index.html
View File

@@ -31,7 +31,7 @@
<meta itemprop="name" content="Tutorials">
<meta itemprop="description" content="Tutorials about how to setup certain features with more detail.">
<meta itemprop="datePublished" content="2025-06-09T13:47:04+02:00">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Tutorials">
<meta name="twitter:description" content="Tutorials about how to setup certain features with more detail.">
@@ -160,8 +160,13 @@
<ul class="ul-2 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsnotifications-li">
<a href="/AudioBookRequest/docs/tutorials/notifications/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsnotifications"><span class="">Notifications</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapi-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-audiobookrequestdocstutorialsapi-li">
<a href="/AudioBookRequest/docs/tutorials/api/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsapi"><span class="">API</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapiindexers-li">
<a href="/AudioBookRequest/docs/tutorials/api/indexers/" class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id="m-audiobookrequestdocstutorialsapiindexers"><span class="">Indexers</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsoidc-li">
<a href="/AudioBookRequest/docs/tutorials/oidc/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsoidc"><span class="">OpenID Connect</span></a>
</li>
@@ -315,7 +320,7 @@
</script>
<br />
<div class="td-page-meta__lastmod">
Last modified August 16, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/93a6315e304a829506136e90fde2f98af71625f9">feat: added env variables for forcing login type and initializing username/password (93a6315)</a>
Last modified August 22, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f">feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)</a>
</div>
</div>

2
docs/tutorials/notifications/_print/index.html
View File

@@ -31,7 +31,7 @@
<meta itemprop="name" content="Notifications">
<meta itemprop="description" content="How to send notifications.">
<meta itemprop="datePublished" content="2025-06-09T13:47:04+02:00">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="160">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Notifications">

11
docs/tutorials/notifications/index.html
View File

@@ -31,7 +31,7 @@
<meta itemprop="name" content="Notifications">
<meta itemprop="description" content="How to send notifications.">
<meta itemprop="datePublished" content="2025-06-09T13:47:04+02:00">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="160">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Notifications">
@@ -161,8 +161,13 @@
<ul class="ul-2 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child active-path" id="m-audiobookrequestdocstutorialsnotifications-li">
<a href="/AudioBookRequest/docs/tutorials/notifications/" class="align-left ps-0 active td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsnotifications"><span class="td-sidebar-nav-active-item">Notifications</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapi-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-audiobookrequestdocstutorialsapi-li">
<a href="/AudioBookRequest/docs/tutorials/api/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsapi"><span class="">API</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapiindexers-li">
<a href="/AudioBookRequest/docs/tutorials/api/indexers/" class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id="m-audiobookrequestdocstutorialsapiindexers"><span class="">Indexers</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsoidc-li">
<a href="/AudioBookRequest/docs/tutorials/oidc/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsoidc"><span class="">OpenID Connect</span></a>
</li>
@@ -337,7 +342,7 @@ one of the following pages:</p>
</script>
<br />
<div class="td-page-meta__lastmod">
Last modified August 16, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/93a6315e304a829506136e90fde2f98af71625f9">feat: added env variables for forcing login type and initializing username/password (93a6315)</a>
Last modified August 22, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f">feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)</a>
</div>
</div>

2
docs/tutorials/oidc/_print/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="OpenID Connect">
<meta itemprop="description" content="Setting up OIDC login">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="546">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="OpenID Connect">

11
docs/tutorials/oidc/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="OpenID Connect">
<meta itemprop="description" content="Setting up OIDC login">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="546">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="OpenID Connect">
@@ -160,8 +160,13 @@
<ul class="ul-2 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsnotifications-li">
<a href="/AudioBookRequest/docs/tutorials/notifications/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsnotifications"><span class="">Notifications</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapi-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-audiobookrequestdocstutorialsapi-li">
<a href="/AudioBookRequest/docs/tutorials/api/" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsapi"><span class="">API</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-audiobookrequestdocstutorialsapiindexers-li">
<a href="/AudioBookRequest/docs/tutorials/api/indexers/" class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id="m-audiobookrequestdocstutorialsapiindexers"><span class="">Indexers</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child active-path" id="m-audiobookrequestdocstutorialsoidc-li">
<a href="/AudioBookRequest/docs/tutorials/oidc/" class="align-left ps-0 active td-sidebar-link td-sidebar-link__section" id="m-audiobookrequestdocstutorialsoidc"><span class="td-sidebar-nav-active-item">OpenID Connect</span></a>
</li>
@@ -403,7 +408,7 @@ receive the <code>Trusted</code> role once they login to AudioBookRequest.
</script>
<br />
<div class="td-page-meta__lastmod">
Last modified August 16, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/93a6315e304a829506136e90fde2f98af71625f9">feat: added env variables for forcing login type and initializing username/password (93a6315)</a>
Last modified August 22, 2025: <a data-proofer-ignore href="https://github.com/markbeep/AudioBookRequest/commit/9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f">feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)</a>
</div>
</div>

2
index.html
View File

@@ -33,7 +33,7 @@ If you’ve heard of Overseer, Ombi, or Jellyseer; this is in the similar vein,
<meta itemprop="name" content="AudioBookRequest">
<meta itemprop="description" content="Welcome to AudioBookRequest! Get started View Code Audiobook request management/wishlist for Plex/Audiobookshelf/Jellyfin Your tool for handling audiobook requests on a Plex/Audiobookshelf/Jellyfin instance.
If you’ve heard of Overseer, Ombi, or Jellyseer; this is in the similar vein, but for audiobooks.">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta itemprop="wordCount" content="39">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="AudioBookRequest">

7
index.xml
View File

@@ -49,6 +49,13 @@
<guid>https://markbeep.github.io/AudioBookRequest/docs/concepts/environment-variables/</guid>
<description>&lt;table&gt;&#xA; &lt;thead&gt;&#xA; &lt;tr&gt;&#xA; &lt;th&gt;ENV&lt;/th&gt;&#xA; &lt;th&gt;Description&lt;/th&gt;&#xA; &lt;th&gt;Default&lt;/th&gt;&#xA; &lt;/tr&gt;&#xA; &lt;/thead&gt;&#xA; &lt;tbody&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;ABR_APP__PORT&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;The port to run the server on.&lt;/td&gt;&#xA; &lt;td&gt;8000&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;ABR_APP__DEBUG&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;If to enable debug mode. Not recommended for production.&lt;/td&gt;&#xA; &lt;td&gt;false&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;ABR_APP__OPENAPI_ENABLED&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;If set to &lt;code&gt;true&lt;/code&gt;, enables an OpenAPI specs page on &lt;code&gt;/docs&lt;/code&gt;.&lt;/td&gt;&#xA; &lt;td&gt;false&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;ABR_APP__CONFIG_DIR&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;The directory path where persistant data and configuration is stored. If ran using Docker or Kubernetes, this is the location a volume should be mounted to.&lt;/td&gt;&#xA; &lt;td&gt;/config&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;ABR_APP__LOG_LEVEL&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;One of &lt;code&gt;DEBUG&lt;/code&gt;, &lt;code&gt;INFO&lt;/code&gt;, &lt;code&gt;WARN&lt;/code&gt;, &lt;code&gt;ERROR&lt;/code&gt;.&lt;/td&gt;&#xA; &lt;td&gt;INFO&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;ABR_APP__BASE_URL&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;Defines the base url the website is hosted at. If the website is accessed at &lt;code&gt;example.org/abr/&lt;/code&gt;, set the base URL to &lt;code&gt;/abr/&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;ABR_DB__SQLITE_PATH&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;If relative, path and name of the sqlite database in relation to &lt;code&gt;ABR_APP__CONFIG_DIR&lt;/code&gt;. If absolute (path starts with &lt;code&gt;/&lt;/code&gt;), the config dir is ignored and only the absolute path is used.&lt;/td&gt;&#xA; &lt;td&gt;db.sqlite&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;ABR_APP__DEFAULT_REGION&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;Default audible region to use for the search. Has to be one of &lt;code&gt;us, ca, uk, au, fr, de, jp, it, in, es, br&lt;/code&gt;.&lt;/td&gt;&#xA; &lt;td&gt;us&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;ABR_APP__FORCE_LOGIN_TYPE&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;Forces the login type and prevents it from being modified. Can be one of &lt;code&gt;basic&lt;/code&gt;, &lt;code&gt;forms&lt;/code&gt;, &lt;code&gt;oidc&lt;/code&gt;, or &lt;code&gt;none&lt;/code&gt; to disable the login. &lt;code&gt;oidc&lt;/code&gt; requires both the &lt;code&gt;ABR_APP__INIT_ROOT_USERNAME&lt;/code&gt; and &lt;code&gt;ABR_APP__INIT_ROOT_PASSWORD&lt;/code&gt; environment variables to be set.&lt;/td&gt;&#xA; &lt;td&gt;&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;ABR_APP__INIT_ROOT_USERNAME&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;Sets the initial username of the root user when first launching ABR. Has no effect if a root admin already exists.&lt;/td&gt;&#xA; &lt;td&gt;&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;ABR_APP__INIT_ROOT_PASSWORD&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;Sets the initial password of the root user when first launching ABR. Has no effect if a root admin already exists.&lt;/td&gt;&#xA; &lt;td&gt;&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;/tbody&gt;&#xA;&lt;/table&gt;&#xA;&#xA;&#xA;&lt;div class=&#34;alert alert-primary&#34; role=&#34;alert&#34;&gt;&#xA;&lt;h4 class=&#34;alert-heading&#34;&gt;Note&lt;/h4&gt;&#xA;&#xA; There are two underscores (&lt;code&gt;__&lt;/code&gt;) between the first&#xA;and second part of each environment variable like between &lt;code&gt;ABR_APP&lt;/code&gt; and &lt;code&gt;PORT&lt;/code&gt;.&#xA;&#xA;&lt;/div&gt;</description>
</item>
<item>
<title>Indexers</title>
<link>https://markbeep.github.io/AudioBookRequest/docs/tutorials/api/indexers/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://markbeep.github.io/AudioBookRequest/docs/tutorials/api/indexers/</guid>
<description>&lt;p&gt;There are two main endpoints to work with indexers:&lt;/p&gt;&#xA;&lt;ul&gt;&#xA;&lt;li&gt;A &lt;code&gt;PATCH&lt;/code&gt; to update indexer settings.&lt;/li&gt;&#xA;&lt;li&gt;A &lt;code&gt;GET&lt;/code&gt; to get all the available configuration settings for the indexers.&lt;/li&gt;&#xA;&lt;/ul&gt;&#xA;&lt;p&gt;Head to the main &lt;a href=&#34;https://markbeep.github.io/AudioBookRequest/docs/tutorials/api/&#34;&gt;API Docs&lt;/a&gt; to see how you can access the SwaggerUI&#xA;and more easily test the endpoints.&lt;/p&gt;&#xA;&lt;h2 id=&#34;getting-the-indexer-configurations&#34;&gt;Getting the Indexer Configurations&lt;a class=&#34;td-heading-self-link&#34; href=&#34;#getting-the-indexer-configurations&#34; aria-label=&#34;Heading self-link&#34;&gt;&lt;/a&gt;&lt;/h2&gt;&#xA;&lt;p&gt;To figure out what values you need to adjust, &lt;code&gt;GET&lt;/code&gt; the endpoint&#xA;&lt;code&gt;/api/indexers/configurations&lt;/code&gt;.&lt;/p&gt;&#xA;&lt;p&gt;This will give you something along the lines of this:&lt;/p&gt;</description>
</item>
<item>
<title>Search Results</title>
<link>https://markbeep.github.io/AudioBookRequest/search/</link>

4
search/index.html
View File

@@ -25,11 +25,11 @@
<meta property="og:description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">
<meta property="og:locale" content="en">
<meta property="og:type" content="article">
<meta property="article:modified_time" content="2025-08-16T11:20:34+02:00">
<meta property="article:modified_time" content="2025-08-22T15:01:53+02:00">
<meta itemprop="name" content="Search Results">
<meta itemprop="description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Search Results">
<meta name="twitter:description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">

57
sitemap.xml
View File

@@ -3,84 +3,87 @@
xmlns:xhtml="http://www.w3.org/1999/xhtml">
<url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/docker/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/getting-started/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/docker-compose/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/getting-started/first-login/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/kubernetes/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/tutorials/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/concepts/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/local-development/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/bare-metal/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/contribution-guidelines/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/tutorials/notifications/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/concepts/environment-variables/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/categories/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/tags/development/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/tags/docker/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/categories/setup/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/tags/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/tutorials/api/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/community/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/categories/development/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/tutorials/api/indexers/</loc>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/tags/local/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/docs/tutorials/oidc/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/search/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url><url>
<loc>https://markbeep.github.io/AudioBookRequest/tags/setup/</loc>
<lastmod>2025-08-16T11:20:34+02:00</lastmod>
<lastmod>2025-08-22T15:01:53+02:00</lastmod>
</url>
</urlset>

2
tags/development/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Development">
<meta itemprop="description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">
<meta itemprop="datePublished" content="2025-06-09T13:03:35+02:00">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Development">
<meta name="twitter:description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">

2
tags/development/index.xml
View File

@@ -6,7 +6,7 @@
<description>Recent content in Development on AudioBookRequest Docs</description>
<generator>Hugo</generator>
<language>en</language>
<lastBuildDate>Sat, 16 Aug 2025 11:20:34 +0200</lastBuildDate>
<lastBuildDate>Fri, 22 Aug 2025 15:01:53 +0200</lastBuildDate>
<atom:link href="https://markbeep.github.io/AudioBookRequest/tags/development/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Bare Metal</title>

2
tags/docker/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Docker">
<meta itemprop="description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">
<meta itemprop="datePublished" content="2025-06-09T13:03:35+02:00">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Docker">
<meta name="twitter:description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">

2
tags/docker/index.xml
View File

@@ -6,7 +6,7 @@
<description>Recent content in Docker on AudioBookRequest Docs</description>
<generator>Hugo</generator>
<language>en</language>
<lastBuildDate>Sat, 16 Aug 2025 11:20:34 +0200</lastBuildDate>
<lastBuildDate>Fri, 22 Aug 2025 15:01:53 +0200</lastBuildDate>
<atom:link href="https://markbeep.github.io/AudioBookRequest/tags/docker/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Docker</title>

2
tags/index.html
View File

@@ -30,7 +30,7 @@
<meta itemprop="name" content="Tags">
<meta itemprop="description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">
<meta itemprop="datePublished" content="2025-06-09T13:03:35+02:00">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Tags">
<meta name="twitter:description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">

2
tags/index.xml
View File

@@ -6,7 +6,7 @@
<description>Recent content in Tags on AudioBookRequest Docs</description>
<generator>Hugo</generator>
<language>en</language>
<lastBuildDate>Sat, 16 Aug 2025 11:20:34 +0200</lastBuildDate>
<lastBuildDate>Fri, 22 Aug 2025 15:01:53 +0200</lastBuildDate>
<atom:link href="https://markbeep.github.io/AudioBookRequest/tags/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Development</title>

2
tags/local/index.html
View File

@@ -29,7 +29,7 @@
<meta itemprop="name" content="Local">
<meta itemprop="description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Local">
<meta name="twitter:description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">

2
tags/setup/index.html
View File

@@ -29,7 +29,7 @@
<meta itemprop="name" content="Setup">
<meta itemprop="description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">
<meta itemprop="dateModified" content="2025-08-16T11:20:34+02:00">
<meta itemprop="dateModified" content="2025-08-22T15:01:53+02:00">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Setup">
<meta name="twitter:description" content="Documentation for AudioBookRequest, a tool to request audiobooks.">