From ea588648f96b5db02fa0d56883c2ba078bd4e74f Mon Sep 17 00:00:00 2001 From: markbeep Date: Fri, 22 Aug 2025 13:02:33 +0000 Subject: [PATCH] deploy: 9b2cda30c01e8d024cc8e66fdef5cf0d46bc153f --- categories/development/index.html | 2 +- categories/index.html | 2 +- categories/index.xml | 2 +- categories/setup/index.html | 2 +- categories/setup/index.xml | 2 +- community/_print/index.html | 2 +- community/index.html | 2 +- docs/_print/index.html | 97 ++++- docs/concepts/_print/index.html | 2 +- .../concepts/environment-variables/index.html | 13 +- docs/concepts/index.html | 11 +- docs/contribution-guidelines/index.html | 13 +- docs/getting-started/_print/index.html | 2 +- .../first-login/_print/index.html | 2 +- docs/getting-started/first-login/index.html | 11 +- docs/getting-started/index.html | 11 +- .../running-the-app/_print/index.html | 2 +- .../running-the-app/bare-metal/index.html | 13 +- .../running-the-app/docker-compose/index.html | 13 +- .../running-the-app/docker/index.html | 13 +- .../running-the-app/index.html | 11 +- .../running-the-app/kubernetes/index.html | 13 +- docs/index.html | 11 +- docs/local-development/_print/index.html | 2 +- docs/local-development/index.html | 11 +- docs/tutorials/_print/index.html | 97 ++++- docs/tutorials/api/_print/index.html | 99 +++-- docs/tutorials/api/index.html | 58 ++- docs/tutorials/api/index.xml | 7 + docs/tutorials/api/indexers/index.html | 401 ++++++++++++++++++ docs/tutorials/index.html | 11 +- .../tutorials/notifications/_print/index.html | 2 +- docs/tutorials/notifications/index.html | 11 +- docs/tutorials/oidc/_print/index.html | 2 +- docs/tutorials/oidc/index.html | 11 +- index.html | 2 +- index.xml | 7 + search/index.html | 4 +- sitemap.xml | 57 +-- tags/development/index.html | 2 +- tags/development/index.xml | 2 +- tags/docker/index.html | 2 +- tags/docker/index.xml | 2 +- tags/index.html | 2 +- tags/index.xml | 2 +- tags/local/index.html | 2 +- tags/setup/index.html | 2 +- 47 files changed, 845 insertions(+), 205 deletions(-) create mode 100644 docs/tutorials/api/indexers/index.html diff --git a/categories/development/index.html b/categories/development/index.html index 72dc84c..071849e 100644 --- a/categories/development/index.html +++ b/categories/development/index.html @@ -29,7 +29,7 @@ - + diff --git a/categories/index.html b/categories/index.html index cb3547b..886d654 100644 --- a/categories/index.html +++ b/categories/index.html @@ -30,7 +30,7 @@ - + diff --git a/categories/index.xml b/categories/index.xml index 20d6442..1cef7a4 100644 --- a/categories/index.xml +++ b/categories/index.xml @@ -6,7 +6,7 @@ Recent content in Categories on AudioBookRequest Docs Hugo en - Sat, 16 Aug 2025 11:20:34 +0200 + Fri, 22 Aug 2025 15:01:53 +0200 Setup diff --git a/categories/setup/index.html b/categories/setup/index.html index 3a5f226..def6090 100644 --- a/categories/setup/index.html +++ b/categories/setup/index.html @@ -30,7 +30,7 @@ - + diff --git a/categories/setup/index.xml b/categories/setup/index.xml index 70ca27b..f13091e 100644 --- a/categories/setup/index.xml +++ b/categories/setup/index.xml @@ -6,7 +6,7 @@ Recent content in Setup on AudioBookRequest Docs Hugo en - Sat, 16 Aug 2025 11:20:34 +0200 + Fri, 22 Aug 2025 15:01:53 +0200 Docker diff --git a/community/_print/index.html b/community/_print/index.html index bfabc26..28bff1f 100644 --- a/community/_print/index.html +++ b/community/_print/index.html @@ -30,7 +30,7 @@ - + diff --git a/community/index.html b/community/index.html index 7d15553..d06927f 100644 --- a/community/index.html +++ b/community/index.html @@ -30,7 +30,7 @@ - + diff --git a/docs/_print/index.html b/docs/_print/index.html index 9522a14..5c23497 100644 --- a/docs/_print/index.html +++ b/docs/_print/index.html @@ -30,7 +30,7 @@ - + @@ -290,6 +290,14 @@ This is the multi-page printable view of this section. + + + +
  • 2.2.1: Indexers
    • + + + + @@ -839,42 +847,28 @@ one of the following pages:

    2.2 - API

    How to use the AudioBookRequest API

    Overview

    -

    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.

    +

    AudioBookRequest provides a RESTful API for a select few endpoints.

    +

    The API uses Bearer token authentication with API keys that can be generated +through the web interface.

    How to Create an API Key

    Follow these steps to create an API key for accessing the AudioBookRequest API:

    -

    Step 1: Access the Web Interface

    -
      -
    1. Open your web browser and navigate to your AudioBookRequest instance
      2. -
    2. Log in with your username and password
      3. -
    -

    Step 2: Navigate to Account Settings

    -
      -
    1. Once logged in, click on the Settings menu
      2. -
    2. Select Account from the settings options
      3. -
    -

    Step 3: Create a New API Key

    1. In the Account settings page, look for the API Keys section
      2. -
    2. Click on Create New API Key or similar button
      3. -
    3. Enter a descriptive name for your API key (e.g., “Mobile App”, “Automation Script”, “Home Assistant Integration”)
      4. -
    4. Click Generate or Create
      5. -
    -

    Step 4: Copy and Store Your API Key

    -
      +
    1. Enter a unique name for your API key
      2. +
    2. Click on Create API Key
    3. Important: The API key will only be displayed once for security reasons
    4. Copy the generated API key immediately and store it in a secure location
    5. If you lose the key, you’ll need to generate a new one
    -

    Step 5: Use Your API Key

    +

    Use Your API Key

    Include your API key in the Authorization header of your API requests:

    Authorization: Bearer <your-api-key>

    Example using cURL:

    -
    curl -H "Authorization: Bearer your-api-key-here" \
-  http://localhost:8000/api/users/me
+
    curl -H "Authorization: Bearer <your-api-key-here>" https://abr.example.com/api/users/me
 
    API Documentation
    
 
    For a SwaggerUI documentation with interactive testing capabilities:
    
 
      
-
    1. Set the environment variable ABR_OPENAPI_ENABLED=true
      2. 
+
    2. Set the environment variable ABR_APP__OPENAPI_ENABLED=true
      3. 
 
    3. Head to <your-domain>/docs.
      4. 
 
    
 
@@ -893,6 +887,63 @@ one of the following pages:
    
   
 
   
+    
+    
+	
+    
+
+
    
+    
+	
    2.2.1 - Indexers
    
+    
    Using the API to access/update indexers
    
+	
    There are two main endpoints to work with indexers:
    
+
      
+
    • A PATCH to update indexer settings.
      • 
+
    • A GET to get all the available configuration settings for the indexers.
      • 
+
    
+
    Head to the main API Docs to see how you can access the SwaggerUI
+and more easily test the endpoints.
    
+
    Getting the Indexer Configurations
    
+
    To figure out what values you need to adjust, GET the endpoint
+/api/indexers/configurations.
    
+
    This will give you something along the lines of this:
    
+
    {
+  "MyAnonamouse": [
+    {
+      "name": "mam_session_id",
+      "description": null,
+      "default": null,
+      "required": true,
+      "type": "str"
+    },
+    {
+      "name": "mam_active",
+      "description": null,
+      "default": "True",
+      "required": false,
+      "type": "bool"
+    }
+  ]
+}
+
    This gives you the full information about what values can be adjusted.
    
+
    Updating Indexer Settings
    
+
    You can update indexer settings by sending a PATCH request to
+/api/indexers/{indexer name}. The name is case-sensitive. The body has to
+be a JSON object with key-value pairs of the values you want to update.
    
+
    Here is an example using cURL: as
    
+
    curl -X 'PATCH' \
+    'https://abr.example.com/api/indexers/MyAnonamouse' \
+    -H 'accept: application/json' \
+    -H 'Authorization: Bearer MaEqMYAGY3qvXxtje6-YDxcs4damlyRaKzTC8itG2b8' \
+    -d '{"mam_session_id":"bXDv1tC1d2MVvOypbFy8Q4Q-rz6q-bKwdqaSZzm85Dg"}'
+
    
+
    
+
+
+
+    
+	
+  
 
     
 	
diff --git a/docs/concepts/_print/index.html b/docs/concepts/_print/index.html
index 3cb6a39..ae74adb 100644
--- a/docs/concepts/_print/index.html
+++ b/docs/concepts/_print/index.html
@@ -30,7 +30,7 @@
 
   
   
-  
+  
   
   
   
diff --git a/docs/concepts/environment-variables/index.html b/docs/concepts/environment-variables/index.html
index 1022a9e..90ae3a3 100644
--- a/docs/concepts/environment-variables/index.html
+++ b/docs/concepts/environment-variables/index.html
@@ -27,12 +27,12 @@
   
     
     
-    
+    
 
   
   
   
-  
+  
   
   
   
@@ -162,8 +162,13 @@
    diff --git a/docs/concepts/index.html b/docs/concepts/index.html index 96385bf..6e91be4 100644 --- a/docs/concepts/index.html +++ b/docs/concepts/index.html @@ -30,7 +30,7 @@ - + @@ -159,8 +159,13 @@
    • Notifications -
    • +
    • API +
    • OpenID Connect
      • @@ -302,7 +307,7 @@
      - Last modified August 16, 2025: feat: added env variables for forcing login type and initializing username/password (93a6315) + Last modified August 22, 2025: feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)
      diff --git a/docs/contribution-guidelines/index.html b/docs/contribution-guidelines/index.html index 19985b3..431cc89 100644 --- a/docs/contribution-guidelines/index.html +++ b/docs/contribution-guidelines/index.html @@ -26,11 +26,11 @@ - + - + @@ -160,8 +160,13 @@
      • Notifications -
      • +
      • API +
      • OpenID Connect
        • @@ -383,7 +388,7 @@ basic introduction to GitHub concepts and workflow.
        - Last modified August 16, 2025: feat: added env variables for forcing login type and initializing username/password (93a6315) + Last modified August 22, 2025: feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)
        diff --git a/docs/getting-started/_print/index.html b/docs/getting-started/_print/index.html index 90ca7cf..c5199b0 100644 --- a/docs/getting-started/_print/index.html +++ b/docs/getting-started/_print/index.html @@ -30,7 +30,7 @@ - + diff --git a/docs/getting-started/first-login/_print/index.html b/docs/getting-started/first-login/_print/index.html index 6bed081..83570e8 100644 --- a/docs/getting-started/first-login/_print/index.html +++ b/docs/getting-started/first-login/_print/index.html @@ -30,7 +30,7 @@ - + diff --git a/docs/getting-started/first-login/index.html b/docs/getting-started/first-login/index.html index de2fb39..8c63e08 100644 --- a/docs/getting-started/first-login/index.html +++ b/docs/getting-started/first-login/index.html @@ -30,7 +30,7 @@ - + @@ -161,8 +161,13 @@
        • Notifications -
        • +
        • API +
        • OpenID Connect
          • @@ -347,7 +352,7 @@ login type.
          - Last modified August 16, 2025: feat: added env variables for forcing login type and initializing username/password (93a6315) + Last modified August 22, 2025: feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)
          diff --git a/docs/getting-started/index.html b/docs/getting-started/index.html index 840f34b..cf5ab77 100644 --- a/docs/getting-started/index.html +++ b/docs/getting-started/index.html @@ -30,7 +30,7 @@ - + @@ -161,8 +161,13 @@
          • Notifications -
          • +
          • API +
          • OpenID Connect
            • @@ -331,7 +336,7 @@ local development, as a lot of things can change from version to version.


            - Last modified August 16, 2025: feat: added env variables for forcing login type and initializing username/password (93a6315) + Last modified August 22, 2025: feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)
            diff --git a/docs/getting-started/running-the-app/_print/index.html b/docs/getting-started/running-the-app/_print/index.html index 33bbeef..33687ac 100644 --- a/docs/getting-started/running-the-app/_print/index.html +++ b/docs/getting-started/running-the-app/_print/index.html @@ -30,7 +30,7 @@ - + diff --git a/docs/getting-started/running-the-app/bare-metal/index.html b/docs/getting-started/running-the-app/bare-metal/index.html index 790e955..616e341 100644 --- a/docs/getting-started/running-the-app/bare-metal/index.html +++ b/docs/getting-started/running-the-app/bare-metal/index.html @@ -27,13 +27,13 @@ - + - + @@ -164,8 +164,13 @@
            • Notifications -
            • +
            • API +
            • OpenID Connect
              • @@ -347,7 +352,7 @@ set in there.
              - Last modified August 16, 2025: feat: added env variables for forcing login type and initializing username/password (93a6315) + Last modified August 22, 2025: feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)
              diff --git a/docs/getting-started/running-the-app/docker-compose/index.html b/docs/getting-started/running-the-app/docker-compose/index.html index c53b612..80e583c 100644 --- a/docs/getting-started/running-the-app/docker-compose/index.html +++ b/docs/getting-started/running-the-app/docker-compose/index.html @@ -27,13 +27,13 @@ - + - + @@ -164,8 +164,13 @@
              • Notifications -
              • +
              • API +
              • OpenID Connect
                • @@ -334,7 +339,7 @@ It would look along the lines of this:


                - Last modified August 16, 2025: feat: added env variables for forcing login type and initializing username/password (93a6315) + Last modified August 22, 2025: feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)
                diff --git a/docs/getting-started/running-the-app/docker/index.html b/docs/getting-started/running-the-app/docker/index.html index eb8a0cf..852dac3 100644 --- a/docs/getting-started/running-the-app/docker/index.html +++ b/docs/getting-started/running-the-app/docker/index.html @@ -27,13 +27,13 @@ - + - + @@ -164,8 +164,13 @@
                • Notifications -
                • +
                • API +
                • OpenID Connect
                  • @@ -336,7 +341,7 @@ the :nightly version tag can be used.


                  - Last modified August 16, 2025: feat: added env variables for forcing login type and initializing username/password (93a6315) + Last modified August 22, 2025: feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)
                  diff --git a/docs/getting-started/running-the-app/index.html b/docs/getting-started/running-the-app/index.html index d2765f4..cb8c894 100644 --- a/docs/getting-started/running-the-app/index.html +++ b/docs/getting-started/running-the-app/index.html @@ -30,7 +30,7 @@ - + @@ -161,8 +161,13 @@
                  • Notifications -
                  • +
                  • API +
                  • OpenID Connect
                    • @@ -335,7 +340,7 @@ different ways.


                    - Last modified August 16, 2025: feat: added env variables for forcing login type and initializing username/password (93a6315) + Last modified August 22, 2025: feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)
                    diff --git a/docs/getting-started/running-the-app/kubernetes/index.html b/docs/getting-started/running-the-app/kubernetes/index.html index 08fb473..7109c85 100644 --- a/docs/getting-started/running-the-app/kubernetes/index.html +++ b/docs/getting-started/running-the-app/kubernetes/index.html @@ -27,13 +27,13 @@ - + - + @@ -164,8 +164,13 @@
                    • Notifications -
                    • +
                    • API +
                    • OpenID Connect
                      • @@ -344,7 +349,7 @@
                      - Last modified August 16, 2025: feat: added env variables for forcing login type and initializing username/password (93a6315) + Last modified August 22, 2025: feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)
                      diff --git a/docs/index.html b/docs/index.html index 1b57e55..53eb89e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -30,7 +30,7 @@ - + @@ -160,8 +160,13 @@
                      • Notifications -
                      • +
                      • API +
                      • OpenID Connect
                        • @@ -369,7 +374,7 @@ structure.


                        - Last modified August 16, 2025: feat: added env variables for forcing login type and initializing username/password (93a6315) + Last modified August 22, 2025: feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)
                        diff --git a/docs/local-development/_print/index.html b/docs/local-development/_print/index.html index 335ad5c..d7d3c3c 100644 --- a/docs/local-development/_print/index.html +++ b/docs/local-development/_print/index.html @@ -30,7 +30,7 @@ - + diff --git a/docs/local-development/index.html b/docs/local-development/index.html index afa34e3..94052c5 100644 --- a/docs/local-development/index.html +++ b/docs/local-development/index.html @@ -30,7 +30,7 @@ - + @@ -161,8 +161,13 @@ @@ -295,42 +303,28 @@ one of the following pages:

                        2 - API

                        How to use the AudioBookRequest API

                        Overview

                        -

                        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.

                        +

                        AudioBookRequest provides a RESTful API for a select few endpoints.

                        +

                        The API uses Bearer token authentication with API keys that can be generated +through the web interface.

                        How to Create an API Key

                        Follow these steps to create an API key for accessing the AudioBookRequest API:

                        -

                        Step 1: Access the Web Interface

                        -
                          -
                        1. Open your web browser and navigate to your AudioBookRequest instance
                          2. -
                        2. Log in with your username and password
                          3. -
                        -

                        Step 2: Navigate to Account Settings

                        -
                          -
                        1. Once logged in, click on the Settings menu
                          2. -
                        2. Select Account from the settings options
                          3. -
                        -

                        Step 3: Create a New API Key

                        1. In the Account settings page, look for the API Keys section
                          2. -
                        2. Click on Create New API Key or similar button
                          3. -
                        3. Enter a descriptive name for your API key (e.g., “Mobile App”, “Automation Script”, “Home Assistant Integration”)
                          4. -
                        4. Click Generate or Create
                          5. -
                        -

                        Step 4: Copy and Store Your API Key

                        -
                          +
                        1. Enter a unique name for your API key
                          2. +
                        2. Click on Create API Key
                        3. Important: The API key will only be displayed once for security reasons
                        4. Copy the generated API key immediately and store it in a secure location
                        5. If you lose the key, you’ll need to generate a new one
                        -

                        Step 5: Use Your API Key

                        +

                        Use Your API Key

                        Include your API key in the Authorization header of your API requests:

                        Authorization: Bearer <your-api-key>

                        Example using cURL:

                        -
                        curl -H "Authorization: Bearer your-api-key-here" \
-  http://localhost:8000/api/users/me
+
                        curl -H "Authorization: Bearer <your-api-key-here>" https://abr.example.com/api/users/me
 
                        API Documentation
                        
 
                        For a SwaggerUI documentation with interactive testing capabilities:
                        
 
                          
-
                        1. Set the environment variable ABR_OPENAPI_ENABLED=true
                          2. 
+
                        2. Set the environment variable ABR_APP__OPENAPI_ENABLED=true
                          3. 
 
                        3. Head to <your-domain>/docs.
                          4. 
 
                        
 
@@ -349,6 +343,63 @@ one of the following pages:
                        
   
 
   
+    
+    
+	
+    
+
+
                        
+    
+	
                        2.1 - Indexers
                        
+    
                        Using the API to access/update indexers
                        
+	
                        There are two main endpoints to work with indexers:
                        
+
                          
+
                        • A PATCH to update indexer settings.
                          • 
+
                        • A GET to get all the available configuration settings for the indexers.
                          • 
+
                        
+
                        Head to the main API Docs to see how you can access the SwaggerUI
+and more easily test the endpoints.
                        
+
                        Getting the Indexer Configurations
                        
+
                        To figure out what values you need to adjust, GET the endpoint
+/api/indexers/configurations.
                        
+
                        This will give you something along the lines of this:
                        
+
                        {
+  "MyAnonamouse": [
+    {
+      "name": "mam_session_id",
+      "description": null,
+      "default": null,
+      "required": true,
+      "type": "str"
+    },
+    {
+      "name": "mam_active",
+      "description": null,
+      "default": "True",
+      "required": false,
+      "type": "bool"
+    }
+  ]
+}
+
                        This gives you the full information about what values can be adjusted.
                        
+
                        Updating Indexer Settings
                        
+
                        You can update indexer settings by sending a PATCH request to
+/api/indexers/{indexer name}. The name is case-sensitive. The body has to
+be a JSON object with key-value pairs of the values you want to update.
                        
+
                        Here is an example using cURL: as
                        
+
                        curl -X 'PATCH' \
+    'https://abr.example.com/api/indexers/MyAnonamouse' \
+    -H 'accept: application/json' \
+    -H 'Authorization: Bearer MaEqMYAGY3qvXxtje6-YDxcs4damlyRaKzTC8itG2b8' \
+    -d '{"mam_session_id":"bXDv1tC1d2MVvOypbFy8Q4Q-rz6q-bKwdqaSZzm85Dg"}'
+
                        
+
                        
+
+
+
+    
+	
+  
 
     
 	
diff --git a/docs/tutorials/api/_print/index.html b/docs/tutorials/api/_print/index.html
index e8efdd1..a65be8f 100644
--- a/docs/tutorials/api/_print/index.html
+++ b/docs/tutorials/api/_print/index.html
@@ -30,8 +30,8 @@
 
   
   
-  
-  
+  
+  
   
   
   
@@ -152,48 +152,42 @@ This is the multi-page printable view of this section.
   
 
   
+    
+    
+	
+
                      • 1: Indexers
                        • 
+
+
+    
+

                      Overview

                      -

                      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.

                      +

                      AudioBookRequest provides a RESTful API for a select few endpoints.

                      +

                      The API uses Bearer token authentication with API keys that can be generated +through the web interface.

                      How to Create an API Key

                      Follow these steps to create an API key for accessing the AudioBookRequest API:

                      -

                      Step 1: Access the Web Interface

                      -
                        -
                      1. Open your web browser and navigate to your AudioBookRequest instance
                        2. -
                      2. Log in with your username and password
                        3. -
                      -

                      Step 2: Navigate to Account Settings

                      -
                        -
                      1. Once logged in, click on the Settings menu
                        2. -
                      2. Select Account from the settings options
                        3. -
                      -

                      Step 3: Create a New API Key

                      1. In the Account settings page, look for the API Keys section
                        2. -
                      2. Click on Create New API Key or similar button
                        3. -
                      3. Enter a descriptive name for your API key (e.g., “Mobile App”, “Automation Script”, “Home Assistant Integration”)
                        4. -
                      4. Click Generate or Create
                        5. -
                      -

                      Step 4: Copy and Store Your API Key

                      -
                        +
                      1. Enter a unique name for your API key
                        2. +
                      2. Click on Create API Key
                      3. Important: The API key will only be displayed once for security reasons
                      4. Copy the generated API key immediately and store it in a secure location
                      5. If you lose the key, you’ll need to generate a new one
                      -

                      Step 5: Use Your API Key

                      +

                      Use Your API Key

                      Include your API key in the Authorization header of your API requests:

                      Authorization: Bearer <your-api-key>

                      Example using cURL:

                      -
                      curl -H "Authorization: Bearer your-api-key-here" \
-  http://localhost:8000/api/users/me
+
                      curl -H "Authorization: Bearer <your-api-key-here>" https://abr.example.com/api/users/me
 
                      API Documentation
                      
 
                      For a SwaggerUI documentation with interactive testing capabilities:
                      
 
                        
-
                      1. Set the environment variable ABR_OPENAPI_ENABLED=true
                        2. 
+
                      2. Set the environment variable ABR_APP__OPENAPI_ENABLED=true
                        3. 
 
                      3. Head to <your-domain>/docs.
                        4. 
 
                      
 
@@ -210,6 +204,63 @@ This is the multi-page printable view of this section.
   
 
   
+    
+    
+	
+    
+
+
                      
+    
+	
                      1 - Indexers
                      
+    
                      Using the API to access/update indexers
                      
+	
                      There are two main endpoints to work with indexers:
                      
+
                        
+
                      • A PATCH to update indexer settings.
                        • 
+
                      • A GET to get all the available configuration settings for the indexers.
                        • 
+
                      
+
                      Head to the main API Docs to see how you can access the SwaggerUI
+and more easily test the endpoints.
                      
+
                      Getting the Indexer Configurations
                      
+
                      To figure out what values you need to adjust, GET the endpoint
+/api/indexers/configurations.
                      
+
                      This will give you something along the lines of this:
                      
+
                      {
+  "MyAnonamouse": [
+    {
+      "name": "mam_session_id",
+      "description": null,
+      "default": null,
+      "required": true,
+      "type": "str"
+    },
+    {
+      "name": "mam_active",
+      "description": null,
+      "default": "True",
+      "required": false,
+      "type": "bool"
+    }
+  ]
+}
+
                      This gives you the full information about what values can be adjusted.
                      
+
                      Updating Indexer Settings
                      
+
                      You can update indexer settings by sending a PATCH request to
+/api/indexers/{indexer name}. The name is case-sensitive. The body has to
+be a JSON object with key-value pairs of the values you want to update.
                      
+
                      Here is an example using cURL: as
                      
+
                      curl -X 'PATCH' \
+    'https://abr.example.com/api/indexers/MyAnonamouse' \
+    -H 'accept: application/json' \
+    -H 'Authorization: Bearer MaEqMYAGY3qvXxtje6-YDxcs4damlyRaKzTC8itG2b8' \
+    -d '{"mam_session_id":"bXDv1tC1d2MVvOypbFy8Q4Q-rz6q-bKwdqaSZzm85Dg"}'
+
                      
+
                      
+
+
+
+    
+	
+  
 
 
 
diff --git a/docs/tutorials/api/index.html b/docs/tutorials/api/index.html
index b4de2f8..7599424 100644
--- a/docs/tutorials/api/index.html
+++ b/docs/tutorials/api/index.html
@@ -30,8 +30,8 @@
 
   
   
-  
-  
+  
+  
   
   
   
@@ -160,8 +160,13 @@
   
                        
     
                      • 
   Notifications
-
                      • 
+
                      • 
   API
+  
 
                      • 
   OpenID Connect
 
                        • 
@@ -202,11 +207,7 @@
     
                      • Overview
                        • 
     
                      • How to Create an API Key
       
     
                        • 
     
                      • API Documentation
                        • 
@@ -254,49 +255,42 @@
 		
   
 	
                        Overview
                        
-
                        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.
                        
+
                        AudioBookRequest provides a RESTful API for a select few endpoints.
                        
+
                        The API uses Bearer token authentication with API keys that can be generated
+through the web interface.
                        
 
                        How to Create an API Key
                        
 
                        Follow these steps to create an API key for accessing the AudioBookRequest API:
                        
-
                        Step 1: Access the Web Interface
                        
-
                          
-
                        1. Open your web browser and navigate to your AudioBookRequest instance
                          2. 
-
                        2. Log in with your username and password
                          3. 
-
                        
-
                        Step 2: Navigate to Account Settings
                        
-
                          
-
                        1. Once logged in, click on the Settings menu
                          2. 
-
                        2. Select Account from the settings options
                          3. 
-
                        
-
                        Step 3: Create a New API Key
                        
 
                          
 
                        1. In the Account settings page, look for the API Keys section
                          2. 
-
                        2. Click on Create New API Key or similar button
                          3. 
-
                        3. Enter a descriptive name for your API key (e.g., “Mobile App”, “Automation Script”, “Home Assistant Integration”)
                          4. 
-
                        4. Click Generate or Create
                          5. 
-
                        
-
                        Step 4: Copy and Store Your API Key
                        
-
                          
+
                        1. Enter a unique name for your API key
                          2. 
+
                        2. Click on Create API Key
                          3. 
 
                        3. Important: The API key will only be displayed once for security reasons
                          4. 
 
                        4. Copy the generated API key immediately and store it in a secure location
                          5. 
 
                        5. If you lose the key, you’ll need to generate a new one
                          6. 
 
                        
-
                        Step 5: Use Your API Key
                        
+
                        Use Your API Key
                        
 
                        Include your API key in the Authorization header of your API requests:
                        
 
                        Authorization: Bearer <your-api-key>
 
                        Example using cURL:
                        
-
                        curl -H "Authorization: Bearer your-api-key-here" \
-  http://localhost:8000/api/users/me
+
                        curl -H "Authorization: Bearer <your-api-key-here>" https://abr.example.com/api/users/me
 
                        API Documentation
                        
 
                        For a SwaggerUI documentation with interactive testing capabilities:
                        
 
                          
-
                        1. Set the environment variable ABR_OPENAPI_ENABLED=true
                          2. 
+
                        2. Set the environment variable ABR_APP__OPENAPI_ENABLED=true
                          3. 
 
                        3. Head to <your-domain>/docs.
                          4. 
 
                        
 
 	
                        
     
     
-    
                        
+    
                        
+        
                        
+                
                        
+                    Indexers
+                
                        
+                
                        Using the API to access/update indexers
                        
+            
                        
+        
                        
 
+
                        
+
+
+
+
+
+
+
                        
+
+
                        
+
                        
+  Last modified August 22, 2025: feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)
+
                        
+
+
                      + + + +
                      + +
                      +
                      +
                      +
                      + + +
                      + + +
                      + © + 2025–2025 + markbeep | CC BY 4.0 |All Rights Reserved +
                      +
                      +
                      +
                      + + + + + + + + \ No newline at end of file diff --git a/docs/tutorials/index.html b/docs/tutorials/index.html index 94341c6..2e0761d 100644 --- a/docs/tutorials/index.html +++ b/docs/tutorials/index.html @@ -31,7 +31,7 @@ - + @@ -160,8 +160,13 @@
                      • Notifications -
                      • +
                      • API +
                      • OpenID Connect
                        • @@ -315,7 +320,7 @@
                        - Last modified August 16, 2025: feat: added env variables for forcing login type and initializing username/password (93a6315) + Last modified August 22, 2025: feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)
                        diff --git a/docs/tutorials/notifications/_print/index.html b/docs/tutorials/notifications/_print/index.html index 9a76197..23fdf00 100644 --- a/docs/tutorials/notifications/_print/index.html +++ b/docs/tutorials/notifications/_print/index.html @@ -31,7 +31,7 @@ - + diff --git a/docs/tutorials/notifications/index.html b/docs/tutorials/notifications/index.html index 533784e..3e9f9b4 100644 --- a/docs/tutorials/notifications/index.html +++ b/docs/tutorials/notifications/index.html @@ -31,7 +31,7 @@ - + @@ -161,8 +161,13 @@
                        • Notifications -
                        • +
                        • API +
                        • OpenID Connect
                          • @@ -337,7 +342,7 @@ one of the following pages:


                          - Last modified August 16, 2025: feat: added env variables for forcing login type and initializing username/password (93a6315) + Last modified August 22, 2025: feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)
                          diff --git a/docs/tutorials/oidc/_print/index.html b/docs/tutorials/oidc/_print/index.html index 1f394c4..d891152 100644 --- a/docs/tutorials/oidc/_print/index.html +++ b/docs/tutorials/oidc/_print/index.html @@ -30,7 +30,7 @@ - + diff --git a/docs/tutorials/oidc/index.html b/docs/tutorials/oidc/index.html index 00482c6..d9d7942 100644 --- a/docs/tutorials/oidc/index.html +++ b/docs/tutorials/oidc/index.html @@ -30,7 +30,7 @@ - + @@ -160,8 +160,13 @@
                          • Notifications -
                          • +
                          • API +
                          • OpenID Connect
                            • @@ -403,7 +408,7 @@ receive the Trusted role once they login to AudioBookRequest.
                            - Last modified August 16, 2025: feat: added env variables for forcing login type and initializing username/password (93a6315) + Last modified August 22, 2025: feat: add API endpoint to update indexers (mam_id). Closes #122 (9b2cda3)
                            diff --git a/index.html b/index.html index ca497ad..f9e0cf6 100644 --- a/index.html +++ b/index.html @@ -33,7 +33,7 @@ If you’ve heard of Overseer, Ombi, or Jellyseer; this is in the similar vein, - + diff --git a/index.xml b/index.xml index 7466cd9..dea3bb8 100644 --- a/index.xml +++ b/index.xml @@ -49,6 +49,13 @@ https://markbeep.github.io/AudioBookRequest/docs/concepts/environment-variables/ <table> <thead> <tr> <th>ENV</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>ABR_APP__PORT</code></td> <td>The port to run the server on.</td> <td>8000</td> </tr> <tr> <td><code>ABR_APP__DEBUG</code></td> <td>If to enable debug mode. Not recommended for production.</td> <td>false</td> </tr> <tr> <td><code>ABR_APP__OPENAPI_ENABLED</code></td> <td>If set to <code>true</code>, enables an OpenAPI specs page on <code>/docs</code>.</td> <td>false</td> </tr> <tr> <td><code>ABR_APP__CONFIG_DIR</code></td> <td>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.</td> <td>/config</td> </tr> <tr> <td><code>ABR_APP__LOG_LEVEL</code></td> <td>One of <code>DEBUG</code>, <code>INFO</code>, <code>WARN</code>, <code>ERROR</code>.</td> <td>INFO</td> </tr> <tr> <td><code>ABR_APP__BASE_URL</code></td> <td>Defines the base url the website is hosted at. If the website is accessed at <code>example.org/abr/</code>, set the base URL to <code>/abr/</code></td> <td></td> </tr> <tr> <td><code>ABR_DB__SQLITE_PATH</code></td> <td>If relative, path and name of the sqlite database in relation to <code>ABR_APP__CONFIG_DIR</code>. If absolute (path starts with <code>/</code>), the config dir is ignored and only the absolute path is used.</td> <td>db.sqlite</td> </tr> <tr> <td><code>ABR_APP__DEFAULT_REGION</code></td> <td>Default audible region to use for the search. Has to be one of <code>us, ca, uk, au, fr, de, jp, it, in, es, br</code>.</td> <td>us</td> </tr> <tr> <td><code>ABR_APP__FORCE_LOGIN_TYPE</code></td> <td>Forces the login type and prevents it from being modified. Can be one of <code>basic</code>, <code>forms</code>, <code>oidc</code>, or <code>none</code> to disable the login. <code>oidc</code> requires both the <code>ABR_APP__INIT_ROOT_USERNAME</code> and <code>ABR_APP__INIT_ROOT_PASSWORD</code> environment variables to be set.</td> <td></td> </tr> <tr> <td><code>ABR_APP__INIT_ROOT_USERNAME</code></td> <td>Sets the initial username of the root user when first launching ABR. Has no effect if a root admin already exists.</td> <td></td> </tr> <tr> <td><code>ABR_APP__INIT_ROOT_PASSWORD</code></td> <td>Sets the initial password of the root user when first launching ABR. Has no effect if a root admin already exists.</td> <td></td> </tr> </tbody> </table> <div class="alert alert-primary" role="alert"> <h4 class="alert-heading">Note</h4> There are two underscores (<code>__</code>) between the first and second part of each environment variable like between <code>ABR_APP</code> and <code>PORT</code>. </div> + + Indexers + https://markbeep.github.io/AudioBookRequest/docs/tutorials/api/indexers/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://markbeep.github.io/AudioBookRequest/docs/tutorials/api/indexers/ + <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="https://markbeep.github.io/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> + Search Results https://markbeep.github.io/AudioBookRequest/search/ diff --git a/search/index.html b/search/index.html index e7d0823..415e13b 100644 --- a/search/index.html +++ b/search/index.html @@ -25,11 +25,11 @@ - + - + diff --git a/sitemap.xml b/sitemap.xml index b538803..fc4aec8 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -3,84 +3,87 @@ xmlns:xhtml="http://www.w3.org/1999/xhtml"> https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/docker/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/docs/getting-started/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/docker-compose/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/docs/getting-started/first-login/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/kubernetes/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/docs/tutorials/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/docs/concepts/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/docs/local-development/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/bare-metal/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/docs/contribution-guidelines/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/docs/tutorials/notifications/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/docs/concepts/environment-variables/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/categories/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/tags/development/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/tags/docker/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/categories/setup/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/tags/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/docs/tutorials/api/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/community/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/categories/development/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/docs/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 + + https://markbeep.github.io/AudioBookRequest/docs/tutorials/api/indexers/ + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/tags/local/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/docs/tutorials/oidc/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/search/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 https://markbeep.github.io/AudioBookRequest/tags/setup/ - 2025-08-16T11:20:34+02:00 + 2025-08-22T15:01:53+02:00 diff --git a/tags/development/index.html b/tags/development/index.html index d56aa5b..2f49ae6 100644 --- a/tags/development/index.html +++ b/tags/development/index.html @@ -30,7 +30,7 @@ - + diff --git a/tags/development/index.xml b/tags/development/index.xml index cb4cb4b..2069f81 100644 --- a/tags/development/index.xml +++ b/tags/development/index.xml @@ -6,7 +6,7 @@ Recent content in Development on AudioBookRequest Docs Hugo en - Sat, 16 Aug 2025 11:20:34 +0200 + Fri, 22 Aug 2025 15:01:53 +0200 Bare Metal diff --git a/tags/docker/index.html b/tags/docker/index.html index 499d421..69be6bc 100644 --- a/tags/docker/index.html +++ b/tags/docker/index.html @@ -30,7 +30,7 @@ - + diff --git a/tags/docker/index.xml b/tags/docker/index.xml index a28a1f4..91b2965 100644 --- a/tags/docker/index.xml +++ b/tags/docker/index.xml @@ -6,7 +6,7 @@ Recent content in Docker on AudioBookRequest Docs Hugo en - Sat, 16 Aug 2025 11:20:34 +0200 + Fri, 22 Aug 2025 15:01:53 +0200 Docker diff --git a/tags/index.html b/tags/index.html index d9f7140..66a027b 100644 --- a/tags/index.html +++ b/tags/index.html @@ -30,7 +30,7 @@ - + diff --git a/tags/index.xml b/tags/index.xml index 12abc45..a15b96d 100644 --- a/tags/index.xml +++ b/tags/index.xml @@ -6,7 +6,7 @@ Recent content in Tags on AudioBookRequest Docs Hugo en - Sat, 16 Aug 2025 11:20:34 +0200 + Fri, 22 Aug 2025 15:01:53 +0200 Development diff --git a/tags/local/index.html b/tags/local/index.html index ebd8c14..d3115ce 100644 --- a/tags/local/index.html +++ b/tags/local/index.html @@ -29,7 +29,7 @@ - + diff --git a/tags/setup/index.html b/tags/setup/index.html index c9cd12e..3ee838a 100644 --- a/tags/setup/index.html +++ b/tags/setup/index.html @@ -29,7 +29,7 @@ - +