mirror/AudioBookRequest
1
0
Fork 0
mirror of https://github.com/markbeep/AudioBookRequest.git synced 2026-01-24 15:09:58 -06:00
Code Issues Packages Projects Releases Wiki Activity
Files
ea588648f96b5db02fa0d56883c2ba078bd4e74f
AudioBookRequest/index.xml
markbeep ea588648f9 deploy: 9b2cda30c0
2025-08-22 13:02:33 +00:00

68 lines
22 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>AudioBookRequest on AudioBookRequest Docs</title>
<link>https://markbeep.github.io/AudioBookRequest/</link>
<description>Recent content in AudioBookRequest on AudioBookRequest Docs</description>
<generator>Hugo</generator>
<language>en</language>
<atom:link href="https://markbeep.github.io/AudioBookRequest/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Docker</title>
<link>https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/docker/</link>
<pubDate>Mon, 09 Jun 2025 13:03:35 +0200</pubDate>
<guid>https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/docker/</guid>
<description>&lt;p&gt;If you prefer to run the app manually with docker, you can simply run the&#xA;following command:&lt;/p&gt;&#xA;&lt;div class=&#34;highlight&#34;&gt;&lt;pre tabindex=&#34;0&#34; style=&#34;color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;&#34;&gt;&lt;code class=&#34;language-bash&#34; data-lang=&#34;bash&#34;&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;docker run -p 8000:8000 -v &lt;span style=&#34;color:#c678dd&#34;&gt;$(&lt;/span&gt;&lt;span style=&#34;color:#ef8383&#34;&gt;pwd&lt;/span&gt;&lt;span style=&#34;color:#c678dd&#34;&gt;)&lt;/span&gt;/config:/config markbeep/audiobookrequest:1&#xA;&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;This will start the container on port 8000 and create the &lt;code&gt;config/&lt;/code&gt; directory in&#xA;your current working directory.&lt;/p&gt;&#xA;&lt;p&gt;The above command might break on Windows. Instead, use&#xA;&lt;code&gt;${PWD}\config:/config ...&lt;/code&gt; in PowerShell or &lt;code&gt;%cd%\config:/config ...&lt;/code&gt; in&#xA;Windows Command Prompt.&lt;/p&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;Versions&lt;/h4&gt;&#xA;&#xA; &lt;p&gt;The &lt;code&gt;:1&lt;/code&gt; at the end denotes the image version.&#xA;Check &lt;a href=&#34;https://hub.docker.com/r/markbeep/audiobookrequest/tags&#34;&gt;dockerhub&lt;/a&gt; for&#xA;any other versions you can use instead.&lt;/p&gt;</description>
</item>
<item>
<title>Docker Compose</title>
<link>https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/docker-compose/</link>
<pubDate>Mon, 09 Jun 2025 13:03:35 +0200</pubDate>
<guid>https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/docker-compose/</guid>
<description>&lt;p&gt;Docker-compose works the similar way as &lt;a href=&#34;https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/docker/&#34;&gt;Docker&lt;/a&gt;.&lt;/p&gt;&#xA;&lt;p&gt;The basic docker compose file is as follows:&lt;/p&gt;&#xA;&lt;div class=&#34;highlight&#34;&gt;&lt;pre tabindex=&#34;0&#34; style=&#34;color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;&#34;&gt;&lt;code class=&#34;language-yaml&#34; data-lang=&#34;yaml&#34;&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;&lt;span style=&#34;color:#e06c75&#34;&gt;services&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;web&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;image&lt;/span&gt;: &lt;span style=&#34;color:#98c379&#34;&gt;markbeep/audiobookrequest:1&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;ports&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#98c379&#34;&gt;&amp;#39;8000:8000&amp;#39;&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;volumes&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#98c379&#34;&gt;./config:/config&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;If you want to add any environment variables, you can add them as explained&#xA;&lt;a href=&#34;https://docs.docker.com/compose/how-tos/environment-variables/set-environment-variables/&#34;&gt;here&lt;/a&gt;.&#xA;It would look along the lines of this:&lt;/p&gt;&#xA;&lt;div class=&#34;highlight&#34;&gt;&lt;pre tabindex=&#34;0&#34; style=&#34;color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;&#34;&gt;&lt;code class=&#34;language-yaml&#34; data-lang=&#34;yaml&#34;&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;&lt;span style=&#34;color:#e06c75&#34;&gt;services&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;web&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;image&lt;/span&gt;: &lt;span style=&#34;color:#98c379&#34;&gt;markbeep/audiobookrequest:1&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;ports&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#98c379&#34;&gt;&amp;#39;8000:5432&amp;#39;&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;volumes&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#98c379&#34;&gt;./config:/config&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;environment&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;ABR_APP__PORT&lt;/span&gt;: &lt;span style=&#34;color:#d19a66&#34;&gt;5432&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;ABR_APP__OPENAPI_ENABLED&lt;/span&gt;: &lt;span style=&#34;color:#b756ff;font-weight:bold&#34;&gt;true&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;</description>
</item>
<item>
<title>Kubernetes</title>
<link>https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/kubernetes/</link>
<pubDate>Mon, 09 Jun 2025 13:03:35 +0200</pubDate>
<guid>https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/kubernetes/</guid>
<description>&lt;p&gt;Here&amp;rsquo;s an example for a kubernetes deployment file you&amp;rsquo;d use:&lt;/p&gt;&#xA;&lt;div class=&#34;highlight&#34;&gt;&lt;pre tabindex=&#34;0&#34; style=&#34;color:#b0c4de;background-color:#282c34;-moz-tab-size:4;-o-tab-size:4;tab-size:4;&#34;&gt;&lt;code class=&#34;language-yaml&#34; data-lang=&#34;yaml&#34;&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;&lt;span style=&#34;color:#e06c75&#34;&gt;apiVersion&lt;/span&gt;: &lt;span style=&#34;color:#98c379&#34;&gt;apps/v1&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;&lt;span style=&#34;color:#e06c75&#34;&gt;kind&lt;/span&gt;: &lt;span style=&#34;color:#98c379&#34;&gt;Deployment&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;&lt;span style=&#34;color:#e06c75&#34;&gt;metadata&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;name&lt;/span&gt;: &lt;span style=&#34;color:#98c379&#34;&gt;audiobookrequest&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;labels&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;app&lt;/span&gt;: &lt;span style=&#34;color:#98c379&#34;&gt;audiobookrequest&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;&lt;span style=&#34;color:#e06c75&#34;&gt;spec&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;replicas&lt;/span&gt;: &lt;span style=&#34;color:#d19a66&#34;&gt;1&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;selector&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;matchLabels&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;app&lt;/span&gt;: &lt;span style=&#34;color:#98c379&#34;&gt;audiobookrequest&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;template&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;metadata&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;labels&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;app&lt;/span&gt;: &lt;span style=&#34;color:#98c379&#34;&gt;audiobookrequest&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;spec&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;containers&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#e06c75&#34;&gt;name&lt;/span&gt;: &lt;span style=&#34;color:#98c379&#34;&gt;audiobookrequest&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;image&lt;/span&gt;: &lt;span style=&#34;color:#98c379&#34;&gt;markbeep/audiobookrequest:1&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;imagePullPolicy&lt;/span&gt;: &lt;span style=&#34;color:#98c379&#34;&gt;Always&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;volumeMounts&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#e06c75&#34;&gt;mountPath&lt;/span&gt;: &lt;span style=&#34;color:#98c379&#34;&gt;/config&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;name&lt;/span&gt;: &lt;span style=&#34;color:#98c379&#34;&gt;abr-config&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;ports&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#e06c75&#34;&gt;name&lt;/span&gt;: &lt;span style=&#34;color:#98c379&#34;&gt;http-request&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;containerPort&lt;/span&gt;: &lt;span style=&#34;color:#d19a66&#34;&gt;8000&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;volumes&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#e06c75&#34;&gt;name&lt;/span&gt;: &lt;span style=&#34;color:#98c379&#34;&gt;abr-config&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;hostPath&lt;/span&gt;:&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#e06c75&#34;&gt;path&lt;/span&gt;: &lt;span style=&#34;color:#98c379&#34;&gt;/mnt/disk/AudioBookRequest/&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;For the volume you can assign it a host path on a node, or assign it to a PVC.&lt;/p&gt;</description>
</item>
<item>
<title>Bare Metal</title>
<link>https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/bare-metal/</link>
<pubDate>Mon, 09 Jun 2025 13:03:35 +0200</pubDate>
<guid>https://markbeep.github.io/AudioBookRequest/docs/getting-started/running-the-app/bare-metal/</guid>
<description>&lt;div class=&#34;alert alert-warning&#34; role=&#34;alert&#34;&gt;&#xA;&lt;h4 class=&#34;alert-heading&#34;&gt;Warning&lt;/h4&gt;&#xA;&#xA; &lt;p&gt;The bare metal approach should&#xA;only be the last option. Try to get it working with Docker or get support on the&#xA;Discord server before trying to set ABR up for a bare metal deployment.&lt;/p&gt;&#xA;&lt;p&gt;There are no guarantees that if one version works locally that it won&amp;rsquo;t suddenly&#xA;break in the next because of a new dependency, new file structure or something&#xA;else.&lt;/p&gt;&#xA;&#xA;&#xA;&lt;/div&gt;&#xA;&#xA;&lt;p&gt;To run ABR locally without Docker, the same steps as for the&#xA;&lt;a href=&#34;https://markbeep.github.io/AudioBookRequest/docs/local-development/&#34;&gt;local development&lt;/a&gt; have to be followed. First, follow&#xA;the instructions to get local development working.&lt;/p&gt;</description>
</item>
<item>
<title>Contribution Guidelines</title>
<link>https://markbeep.github.io/AudioBookRequest/docs/contribution-guidelines/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://markbeep.github.io/AudioBookRequest/docs/contribution-guidelines/</guid>
<description>&lt;p&gt;We use &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; to format and generate our website, the&#xA;&lt;a href=&#34;https://github.com/google/docsy&#34;&gt;Docsy&lt;/a&gt; theme for styling and site structure,&#xA;and &lt;a href=&#34;https://pages.github.com/&#34;&gt;Github Pages&lt;/a&gt; to manage the deployment of the&#xA;site. Hugo is an open-source static site generator that provides us with&#xA;templates, content organisation in a standard directory structure, and a website&#xA;generation engine. You write the pages in Markdown (or HTML if you want), and&#xA;Hugo wraps them up into a website.&lt;/p&gt;&#xA;&lt;p&gt;All submissions require review. We use GitHub pullas requests for this purpose.&#xA;Consult &lt;a href=&#34;https://help.github.com/articles/about-pull-requests/&#34;&gt;GitHub Help&lt;/a&gt; for&#xA;more information on using pull requests.&lt;/p&gt;</description>
</item>
<item>
<title>Environment Variables</title>
<link>https://markbeep.github.io/AudioBookRequest/docs/concepts/environment-variables/</link>
<pubDate>Mon, 09 Jun 2025 13:46:33 +0200</pubDate>
<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>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://markbeep.github.io/AudioBookRequest/search/</guid>
<description></description>
</item>
</channel>
</rss>
Reference in New Issue View Git Blame Copy Permalink