rename documentation files for simple routing paths and reorganise for better navigation

docs/advanced/advanced.md

@@ -0,0 +1,186 @@
+# Advanced
+
+## Files and folders
+
+To make upgrades and reinstalls easier, Libation separates all of its responsibilities to a few different folders. If you don't want to mess with this stuff: ignore it. Read on if you like a little more control over your files.
+
+- In Libation's initial folder are the files that make up the program. Since nothing else is here, just copy new files here to upgrade the program. Delete this folder to delete Libation.
+
+- In a separate folder, Libation keeps track of all of the files it creates like settings and downloaded images. After an upgrade, Libation might think that's its being run for the first time. Just click ADVANCED SETUP and point to this folder. Libation will reload your library and settings.
+
+- The last important folder is the "books location." This is where Libation looks for your downloaded and decrypted books. This is how it knows which books still need to be downloaded. The Audible id must be somewhere in the book's file or folder name for Libation to detect your downloaded book.
+
+## Settings
+
+- Allow Libation to fix up audiobook metadata. After decrypting a title, Libation attempts to fix details like chapters and cover art. Some power users and/or control freaks prefer to manage this themselves. By unchecking this setting, Libation will only decrypt the book and will leave metadata as-is, warts and all.
+
+In addition to the options that are enabled if you allow Libation to "fix up" the audiobook, it does the following:
+
+- Adds the `TCOM` (`@wrt` in M4B files) metadata tag for the narrators.
+- Sets the `©gen` metadata tag for the genres.
+- Unescapes the copyright symbol (replace `©` with `©`)
+- Replaces the recording copyright `(P)` string with `℗`
+- Replaces the chapter markers embedded in the aax file with the chapter markers retrieved from Audible's API.
+- Sets the embedded cover art image with the 500x500 px cover art retrieved from Audible
+
+## Custom Theme Colors
+
+In Libation Chardonnay (not Classic), you may adjust the app colors using the built-in theme editor. Open the Settings window (from the menu bar: Settings > Settings). On the "Important" settings tab, click "Edit Theme Colors".
+
+
+### Theme Editor Window
+
+The theme editor has a list of style names and their currently assigned colors. To change a style color, click on the color swatch in the left-hand column to open the color editor for that style. Observe the color changes in real-time on the built-in preview panel on the right-hand side of the theme editor.
+
+You may import or export themes using the buttons at the bottom-left of the theme editor.
+"Cancel" or closing the window will revert any changes you've made in the theme editor.
+"Reset" will reset any changes you've made in the theme editor.
+"Defaults" will restore the application default colors for the active theme ("Light" or "Dark")
+"Save" will save the theme colors to the ChardonnayTheme.json file and close the editor.
+
+::: info 
+Note: you may only edit the currently applied theme ("Light" or
+"Dark"). 
+:::
+
+### Video Walkthrough
+
+The below video demonstrates using the theme editor to make changes to the Dark theme color pallet.
+
+[](https://github.com/user-attachments/assets/05c0cb7f-578f-4465-9691-77d694111349)
+
+## Command Line Interface
+
+Libationcli.exe allows limited access to Libation's functionalities as a CLI.
+
+Warnings about relying solely on on the CLI:
+- CLI will not perform any upgrades.
+- It will show that there is an upgrade, but that will likely scroll by too fast to notice.
+- It will not perform all post-upgrade migrations. Some migrations are only be possible by launching GUI.
+
+### Help
+
+```console
+libationcli --help
+```
+
+### Verb-Specific Help
+
+```console
+libationcli scan --help
+```
+
+### Scan All Libraries
+
+```console
+libationcli scan
+```
+
+### Scan Only Libraries for Specific Accounts
+
+```console
+libationcli scan nickname1 nickname2
+```
+
+### Convert All m4b Files to mp3
+
+```console
+libationcli convert
+```
+
+### Liberate All Books and Pdfs
+
+```console
+libationcli liberate
+```
+
+### Liberate Pdfs Only
+
+```console
+libationcli liberate --pdf
+libationcli liberate -p
+```
+
+### Force Book(s) to Re-Liberate
+
+```console
+libationcli liberate --force
+libationcli liberate -f
+```
+
+### Liberate using a license file from the `get-license` command
+
+```console
+libationcli liberate --license /path/to/license.lic
+libationcli liberate --license - < /path/to/license.lic
+```
+
+### List Libation Settings
+
+```console
+libationcli get-setting
+libationcli get-setting -b
+libationcli get-setting FileDownloadQuality
+```
+
+### Override Libation Settings for the Command
+
+```console
+libationcli liberate B017V4IM1G -override FileDownloadQuality=Normal
+libationcli liberate B017V4IM1G -o FileDownloadQuality=normal -o UseWidevine=true Request_xHE_AAC=true -f
+```
+
+### Copy the Local SQLite Database to Postgres
+
+```console
+libationcli copydb --connectionString "my postgres connection string"
+libationcli copydb -c "my postgres connection string"
+```
+
+### Export Library to File
+
+```console
+libationcli export --path "C:\foo\bar\my.json" --json
+libationcli export -p "C:\foo\bar\my.json" -j
+libationcli export -p "C:\foo\bar\my.csv" --csv
+libationcli export -p "C:\foo\bar\my.csv" -c
+libationcli export -p "C:\foo\bar\my.xlsx" --xlsx
+libationcli export -p "C:\foo\bar\my.xlsx" -x
+```
+
+### Set Download Status
+
+Set download statuses throughout library based on whether each book's audio file can be found.   
+Must include at least one flag: --downloaded , --not-downloaded.  
+Downloaded: If the audio file can be found, set download status to 'Downloaded'.  
+Not Downloaded: If the audio file cannot be found, set download status to 'Not Downloaded'  
+UI: Visible Books \> Set 'Downloaded' status automatically. Visible books. Prompts before saving changes  
+CLI: Full library. No prompt
+
+```console
+libationcli set-status -d
+libationcli set-status -n
+libationcli set-status -d -n
+```
+
+### Get a Content License Without Downloading
+
+```console
+libationcli get-license B017V4IM1G
+```
+
+### Example Powershell Script to Download Four Differenf Versions f the Same Book
+
+```powershell
+$asin="B017V4IM1G"
+
+$xHE_AAC=@('true', 'false')
+$Qualities=@('Normal', 'High')
+foreach($q in $Qualities){
+  foreach($x in $xHE_AAC){
+	$license = ./libationcli get-license $asin --override FileDownloadQuality=$q --override Request_xHE_AAC=$x
+	echo $($license | ConvertFrom-Json).ContentMetadata.content_reference
+	echo $license | ./libationcli liberate --force --license -
+  }
+}
+```

docs/advanced/linux-development-setup-using-nix.md

@@ -0,0 +1,64 @@
+# Development Environment Setup using Nix or Nix Flakes on Linux x86_64
+[Nix flakes](https://nixos.wiki/wiki/Flakes) can be used to provide version controlled reproducible and cross-platform development environments. The key files are:
+- `flake.nix`: Defines the flake inputs and outputs, including development shells.
+- `shell.nix`: This file defines the dependencies and additionally adds support for the Impure `nix-shell` method. This is used by the flake to create the dev environment.
+- `flake.lock`: Locks the versions of inputs for reproducibility.
+---
+## Prerequisites
+- [Nix](https://nixos.org/download.html) the package manager or NixOs installed on Linux (x86_64-linux)
+- Optional: flakes support enabled. 
+---
+## Using the Development Shell
+You have two primary ways to enter the development shell with Nix:
+### 1. Using `nix develop` (flake-native command)
+This is the recommended way if you have Nix with flakes support. Flake guarantee the versions of the dependencies and can be controlled through `flake.nix` and `flake.lock`.
+```
+nix develop
+```
+This will open a shell with all dependencies and environment configured as per the `flake.nix` for (`x86_64-linux`) systems only at this time.
+
+---
+### 2. Using `nix-shell` (that's why shell.nix is a separate file)
+If you want to use traditional `nix-shell` tooling which uses the nixpkgs version of your system:
+```
+nix-shell
+```
+This will drop you into the shell environment defined in `shell.nix`. Note that this is not flake-native method and does not use the locked nixpkgs in `flake.lock` so exact versions of the dependancies is not guaranteed.
+
+---
+## What’s inside the dev shell?
+- The environment variables and packages configured in `shell.nix` will be available.
+- The package set (`pkgs`) used aligns with the versions locked in `flake.lock` to ensure reproducibility.
+
+---
+## Example Workflow using flakes
+```
+# Navigate to the project root folder which contains the flake.nix, flake.lock and shell.nix files.
+cd /home/user/dev/Libation
+# Enter the flake development shell (Linux x86_64)
+nix develop
+# run VSCode or VSCodium from the current shell environment
+code .
+# Run or Debug using VSCode and VSCodium using the linux Launch configuration.
+```
+![Debug using VSCode and VSCodium](../images/StartingDebuggingInVSCode.png)
+
+You can also Build and run your application inside the shell.
+``` 
+dotnet build ./Source/LibationAvalonia/LibationAvalonia.csproj -p:TargetFrameworks=net9.0 -p:TargetFramework=net9.0 -p:RuntimeIdentifier=linux-x64
+```
+
+---
+
+## Notes
+- Leaving the current shell environemnt will drop all added dependancies and you will not be able to run or debug the program unless your system has those dependancies defined globally.
+- To exit the shell environment voluntarily use `exit` inside the shell.
+- Ensure you have no conflicting `nix.conf` or `global.json` that might affect SDK versions or runtime identifiers.
+- Keep your `flake.lock` file committed to ensure builds are reproducible for all collaborators.
+
+---
+## References
+
+- [Nix Flakes - NixOS Wiki](https://nixos.wiki/wiki/Flakes)
+- [Nix.dev - Introduction to Nix flakes](https://nix.dev/manual/nix/2.28/command-ref/new-cli/nix3-flake-init)
+- [Nix-shell Manual](https://nixos.org/manual/nix/stable/command-ref/nix-shell.html)

docs/features/audio-file-formats.md

@@ -0,0 +1,104 @@
+# Audio Formats Produced by Libation
+
+Libation will download audio in a number of different audio formats, depending on the settings you choose within Libation and the per-title availability of audio formats from Audible. The Libation settings which affect the format downloaded by Libation are shown in the Settings menu screenshot below.
+
+Notes:
+- Audiobook file extensions are either `.m4b` or `.mp3`. Libation uses the `.m4b` file extension for all non-MP3 files, regardless of the audio codec contained therein. Some media players don't recognize the `.m4b` file extension and may require the extension be changed to `.m4a` or `.mp4`.
+- Most (but not all) podcasts are delivered by Audible as native MP3 files. None of the following audio formats and settings discussions pertain to those podcasts because MP3s have no DRM, and those episodes are copied directly to their output folders.
+
+![Audio format settings menu](../images/AudioFormatSettings.png)
+
+## Settings Summary
+### Audio quality to request from Audible
+Audiobooks can be requested from Audible as "Normal" quality or "High" quality, matching the settings in the Audible mobile apps. This setting affects the audio bitrate and, sometimes, the number of audio channels. This setting has no effect on the _audio codec_.
+
+### Use Widevine DRM
+When this setting is disabled, all audiobooks will be downloaded using Audible's in-house DRM (AAX(C)) in the [AAC-LC](#aac-lc) format.
+When this setting is enabled, Libation will request audio files protected by Google's Widevine Digital Rights Managements scheme, and two additional settings will be unlocked: [Request xHE-AAC Codec](#request-xhe-aac-codec) and [Request Spatial Audio](#request-spatial-audio) (explained further below).
+
+If you don't enable either of those additional options, then enabling 'Use Widevine DRM' will have no pratcical effect in nearly all circumstances. Audiobooks will be downloaded in the same [AAC-LC](#aac-lc) format with the same bitrate and the same number of audio channels. On rare occasions, enabling 'Use Widevine DRM' without the other two options will result in audio files with a different bitrate.
+
+### Request xHE-AAC Codec
+Enable this setting to request audiobooks in the [xHE-AAC](#xhe-aac) format. This codec is generally better quality than the [AAC-LC](#aac-lc) codec at the same bitrate, but it isn't as commonly supported by media players, so you may have some difficulty playing these audiobooks. The highest bitrate version of some audiobooks is only available as [xHE-AAC](#xhe-aac).
+
+### Request Spatial Audio
+Enable this setting to request audiobooks in a "spatial" ([Dolby Atmos](#dolby-atmos)) audio format. If an audiobook is not available in a spatial format, it will instead be downloaded in the [xHE-AAC codec](#xhe-aac).
+
+### Spatial audio codec
+Choose whether spatial audiobooks are downloaded in the [E-AC-3](#e-ac-3) or [AC-4](#ac-4) format.
+
+### Download my books in the original audio format (Lossless)
+If selected, Audiobooks will be downloaded and saved in the format delivered by audible (which depends on the settings explained above). Libation will not change the audio.
+
+### Download my books as .MP3 files (transcode if necessary).
+If selected, Libation will decode [AAC-LC](#aac-lc), [xHE-AAC](#xhe-aac), and [E-AC-3](#e-ac-3) audiobooks and re-encode them as MP3s using the MP3 encoder settings ([read about LAME MP3 encoder settings](https://lame.sourceforge.io/lame_ui_example.php)). Note that Libation cannot convert [AC-4](#ac-4) audio to MP3.
+
+# Audio Formats
+
+## Traditional Mono and Stereo Formats
+
+### AAC-LC
+#### _Full Name_
+Advanced Audio Coding - Low Complexity
+#### _Description_
+This is the base profile for AAC audio and has existed since AAC's initial release in 1997. It enjoys wide support on nearly every conceivable platform capable of playing digital audio, as ubiquitous as MP3.
+If Widevine support is not enabled, or if the book is not available in the more high-definition formats, Libation will download audiobooks in this format.
+
+### MP3
+#### _Full Name_
+MPEG-1 Audio Layer III or MPEG-2 Audio Layer III
+#### _Description_
+An older (released in 1991) but still nearly universally supported audio codec. Its audio quality is generally worse than AAC-LC at similar bitrates. Audible delivers some podcasts in MP3 format, but no audiobooks are natively availble as MP3. Libation supports converting Audiobooks delivered in other audio formats to MP3. Note that the MP3 format supports a maximum of two audio channels, so multichannel E-AC-3 audio will be downsampled to stereo or mono (depending on the Libation's settings). [AC-4](#ac-4) cannot be converted to MP3.
+
+### xHE-AAC
+#### _Full Name_
+Extended High-Efficiency Advanced Audio Coding
+#### _Description_
+This is a proprietary codec created by the [Fraunhofer Institute for Integrated Circuits IIS](https://www.iis.fraunhofer.de/en/ff/amm/broadcast-streaming/xheaac.html). It combines features of the HE-AAC v2 and the baseline USAC (Unified Speech and Audio Coding) profiles with the parts of the MPEG-D DRC Loudness Control Profile or Dynamic Range Control Profile. Therefore, USAC and xHE-AAC are not synonymous and should not be used interchangeably. A player capable of decoding USAC will not necessarily be able to decode xHE-AAC.
+
+xHE-AAC boasts significantly higher quality audio at low bitrates. Though it has existed since at least 2016, playback support is still quite limited. FFmpeg has recently added partial decoder support for the USAC profiles, but it is insufficient to decode the xHE-AAC audio files acquired from Audible (due to FFmpeg's lack of support for MPEG Surround for Mono to Stereo Upmixing; ISO 23003-3:2012 §7.11)
+
+Note that the xHE-AAC files authored by Audible have some USAC conformance errors including:
+- Number of samples per frame not matching the UsacConfig coreCoderFrameLength value.
+- Disagreement between stts and UsacFrame usacIndependencyFlag value.
+- Stts indicating a frame is an immediate play-out frame, but USAC AudioPreRoll is absent.
+
+## Dolby Atmos
+Atmos is a surround sound technology that expands on existing surround sound systems by adding height channels as well as free-moving sound objects. Audible delivers Dolby Atmos in two formats: E-AC-3 and AC-4.
+
+Your device's ability to play audio from these formats does not necessarily mean that the audio you are hearing is Atmos (spatial). For instance, downloading the AC-4 codec for Windows ([links in the [Supported media Players](#supported-media-players) section) will enable you to play AC-4 audiobooks, but you'll still need to download [Dolby Access](https://apps.microsoft.com/detail/9n0866fs04w8?hl=en-US&gl=US) and pay $15 to enable _Dolby Atmos For Headphones_. Please refer to [this comment](https://github.com/rmcrackan/Libation/pull/1331#discussion_r2268660524) for additional context.
+
+### E-AC-3
+#### _Full Name_
+Dolby Digital Plus (a.k.a Enhanced AC-3, DDP, DD+, and EC-3)
+#### _Description_
+A proprietary digital audio compression scheme developed by Dolby Digital for the transport and storage of multichannel audio. This format can be extended to add support for Atmos, making the codec _Dolby Digital Plus Atmos_. _Dolby Digital Plus Atmos_ is backwards compatible with Dolby Digital Plus, so any media player capable of playing Dolby Digital Plus can play _Dolby Digital Plus Atmos_. Audible spatial audiobooks downloaded in the E-AC-3 format are _Dolby Digital Plus Atmos_. If they are played by a media player that supports Atmos, they will play as Atmos audio. If they are played by a media player that does not support Atmos, they will be played as traditional 5.1 surround audio.
+
+### AC-4
+#### _Full Name_
+Dolby AC-4
+#### _Description_
+A proprietary audio compression technology developed by Dolby Digital for the transport and storage of audio channels and/or audio objects. Audible spatial audiobooks downloaded in the AC-4 format are 2-channel AC-4 Immersive Stereo (AC4-IMS) audio, intended for playback in headphones or earbuds (though apparently [not supported on Apple devices](https://github.com/rmcrackan/Libation/issues/996#issuecomment-3169574514)).
+
+# Supported Media Players
+Below is an incomplete matrix of codec support across various media players and platforms.
+| Player | [AAC-LC](#aac-lc) | [xHE-AAC](#xhe-aac) | [E-AC-3](#e-ac-3) | [AC-4](#ac-4) |
+| :--- | :---: | :---: | :---: | :---: |
+|Windows Native Support|Yes|Yes<sup>1</sup>|Yes<sup>2,3</sup>|Yes<sup>4</sup>|
+|macOS Native Support|Yes|Yes|Yes<sup>3</sup>| |
+|Android Native Support<sup>5</sup>|Yes|Yes| | |
+|FFmpeg (all platforms)|Yes|Yes<sup>6</sup>|Yes<sup>3</sup>||
+|[VLC](https://www.videolan.org/vlc/) (Windows)|Yes| |Yes<sup>3</sup> | |
+|[foobar2000](https://www.foobar2000.org/components) (Windows and Mac)|Yes|Yes<sup>7</sup> | | |
+|[PotPlayer](https://potplayer.daum.net/) (Windows)|Yes|Yes|Yes<sup>3</sup>| |
+|[Samsung Media Player](https://play.google.com/store/apps/details?id=com.sec.android.app.music)<sup>8</sup> (Samsung devices) |Yes|Yes|Yes|Yes|
+
+1. Windows 11 22H2 and later
+2. On Windows [prior to Windows 11, version 24H2](https://support.microsoft.com/en-us/windows/codecs-in-media-player-d5c2cdcd-83a2-4805-abb0-c6888138e456). You can still get the codec by running the following command from a Windows PowerShell console: `winget install --id 9nvjqjbdkn97`
+3. As mentioned in the [Dolby Atmos](#dolby-atmos) section, just because a media player can play a file does not mean it's rendering Atmos. _Dolby Digital Plus Atmos_ is backwards compatible with _Dolby Digital Plus_, so media players which only support _Dolby Digital Plus_ will play E-AC-3 audio files as regular 5.1 surround without rendering the Atmos spatial qualities. Additional software or hardware support may be required for Dolby Atmos playback.
+4. You can download the AC-4 codec for Windows from 3rd party sites like [Major Geeks](https://www.majorgeeks.com/files/details/dolby_ac_3ac_4_installer.html) and [Free-Codecs](https://www.free-codecs.com/dolby-ac-4-decoder_download.htm). Once you install the codec bundle from one of those sources, the Windows store app will keep it updated. Read more about the process [in this comment](https://github.com/rmcrackan/Libation/pull/1331#discussion_r2268660524).
+5. All Android devices will support AAC-LC and xHE-AAC. Some manufactures (such as Samsung) will include Dolby codecs for playing E-AC-3 and AC-4 audio.
+6. requires FFmpeg to be [built with fdk-aac](https://trac.ffmpeg.org/wiki/Encode/AAC#fdk_aac). You will almost certainly not find pre-build binaries in the wild due to licensing restrictions.
+7. Requires the [fdk-aac plugin](https://www.foobar2000.org/components/view/foo_pd_aac) (Windows only)
+8. Requires audio file extensions to be `.m4a` or `.mp4`. Libation sets the file extensions to `.m4b`, so you must manually change it to `.m4a` by renaming the audio file.
+

docs/features/naming-templates.md

@@ -0,0 +1,160 @@
+
+
+
+# Naming Templates
+File and Folder names can be customized using Libation's built-in tag template naming engine. To edit how folder and file names are created, go to Settings \> Download/Decrypt and edit the naming templates. If you're splitting your audiobook into multiple files by chapter, you can also use a custom template to set each chapter's title metadata tag by editing the template in Settings \> Audio File Options.
+
+These templates apply to both GUI and CLI.
+
+
+# Template Tags
+
+These are the naming template tags currently supported by Libation.
+
+## Property Tags
+These tags will be replaced in the template with the audiobook's values.
+
+|Tag|Description|Type|
+|-|-|-|
+|\<id\> **†**|Audible book ID (ASIN)|Text|
+|\<title\>|Full title with subtitle|[Text](#text-formatters)|
+|\<title short\>|Title. Stop at first colon|[Text](#text-formatters)|
+|\<audible title\>|Audible's title (does not include subtitle)|[Text](#text-formatters)|
+|\<audible subtitle\>|Audible's subtitle|[Text](#text-formatters)|
+|\<author\>|Author(s)|[Name List](#name-list-formatters)|
+|\<first author\>|First author|[Name](#name-formatters)|
+|\<narrator\>|Narrator(s)|[Name List](#name-list-formatters)|
+|\<first narrator\>|First narrator|[Name](#name-formatters)|
+|\<series\>|All series to which the book belongs (if any)|[Series List](#series-list-formatters)|
+|\<first series\>|First series|[Series](#series-formatters)|
+|\<series#\>|Number order in series (alias for \<first series[{#}]\>|[Number](#number-formatters)|
+|\<bitrate\>|Bitrate (kbps) of the last downloaded audiobook|[Number](#number-formatters)|
+|\<samplerate\>|Sample rate (Hz) of the last downloaded audiobook|[Number](#number-formatters)|
+|\<channels\>|Number of audio channels in the last downloaded audiobook|[Number](#number-formatters)|
+|\<codec\>|Audio codec of the last downloaded audiobook|[Text](#text-formatters)|
+|\<file version\>|Audible's file version number of the last downloaded audiobook|[Text](#text-formatters)|
+|\<libation version\>|Libation version used during last download of the audiobook|[Text](#text-formatters)|
+|\<account\>|Audible account of this book|[Text](#text-formatters)|
+|\<account nickname\>|Audible account nickname of this book|[Text](#text-formatters)|
+|\<locale\>|Region/country|[Text](#text-formatters)|
+|\<year\>|Year published|[Number](#number-formatters)|
+|\<language\>|Book's language|[Text](#text-formatters)|
+|\<language short\> **†**|Book's language abbreviated. Eg: ENG|Text|
+|\<file date\>|File creation date/time.|[DateTime](#date-formatters)|
+|\<pub date\>|Audiobook publication date|[DateTime](#date-formatters)|
+|\<date added\>|Date the book added to your Audible account|[DateTime](#date-formatters)|
+|\<ch count\> **‡**|Number of chapters|[Number](#number-formatters)|
+|\<ch title\> **‡**|Chapter title|[Text](#text-formatters)|
+|\<ch#\> **‡**|Chapter number|[Number](#number-formatters)|
+|\<ch# 0\> **‡**|Chapter number with leading zeros|[Number](#number-formatters)|
+
+**†** Does not support custom formatting
+
+**‡** Only valid for Chapter Filename and Chapter Tile Metadata
+
+To change how these properties are displayed, [read about custom formatters](#tag-formatters)
+
+## Conditional Tags
+Anything between the opening tag (`<tagname->`) and closing tag (`<-tagname>`) will only appear in the name if the condition evaluates to true. 
+
+|Tag|Description|Type|
+|-|-|-|
+|\<if series-\>...\<-if series\>|Only include if part of a book series or podcast|Conditional|
+|\<if podcast-\>...\<-if podcast\>|Only include if part of a podcast|Conditional|
+|\<if bookseries-\>...\<-if bookseries\>|Only include if part of a book series|Conditional|
+|\<if podcastparent-\>...\<-if podcastparent\>**†**|Only include if item is a podcast series parent|Conditional|
+|\<has PROPERTY-\>...\<-has\>|Only include if the PROPERTY has a value (i.e. not null or empty)|Conditional|
+
+**†** Only affects the podcast series folder naming if "Save all podcast episodes to the series parent folder" option is checked.
+
+For example, `<if podcast-><series><-if podcast>` will evaluate to the podcast's series name if the file is a podcast. For audiobooks that are not podcasts, that tag will be blank.
+
+You can invert the condition (instead of displaying the text when the condition is true, display the text when it is false) by playing a `!` symbol before the opening tag name. 
+
+|Inverted Tag|Description|Type|
+|-|-|-|
+|\<!if series-\>...\<-if series\>|Only include if *not* part of a book series or podcast|Conditional|
+|\<!if podcast-\>...\<-if podcast\>|Only include if *not* part of a podcast|Conditional|
+|\<!if bookseries-\>...\<-if bookseries\>|Only include if *not* part of a book series|Conditional|
+|\<!if podcastparent-\>...\<-if podcastparent\>**†**|Only include if item is *not* a podcast series parent|Conditional|
+|\<!has PROPERTY-\>...\<-has\>|Only include if the PROPERTY *does not* have a value (i.e. is null or empty)|Conditional|
+
+**†** Only affects the podcast series folder naming if "Save all podcast episodes to the series parent folder" option is checked.
+
+As an example, this folder template will place all Liberated podcasts into a "Podcasts" folder and all liberated books (not podcasts) into a "Books" folder.
+
+`<if podcast->Podcasts<-if podcast><!if podcast->Books<-if podcast>\<title>`
+
+This example will add a number if the `<series#\>` tag has a value:
+
+`<has series#><series#><-has>`
+
+This example will put non-series books in a "Standalones" folder:
+
+`<!if series->Standalones/<-if series>`
+
+And this example will customize the title based on whether the book has a subtitle:
+
+`<audible title><has audible subtitle->-<audible subtitle><-has>`
+
+# Tag Formatters
+**Text**, **Name List**, **Number**, and **DateTime** tags can be optionally formatted using format text in square brackets after the tag name. Below is a list of supported formatters for each tag type.
+
+## Text Formatters
+|Formatter|Description|Example Usage|Example Result|
+|-|-|-|-|
+|L|Converts text to lowercase|\<title[L]\>|a study in scarlet꞉ a sherlock holmes novel|
+|U|Converts text to uppercase|\<title short[U]\>|A STUDY IN SCARLET|
+
+## Series Formatters
+|Formatter|Description|Example Usage|Example Result|
+|-|-|-|-|
+|\{N \| # \| ID\}|Formats the series using<br>the series part tags.<br>\{N\} = Series Name<br>\{#\} = Number order in series<br>\{#:[Number_Formatter](#number-formatters)\} = Number order in series, formatted<br>\{ID\} = Audible Series ID<br><br>Default is \{N\}|`<first series>`<hr>`<first series[{N}]>`<hr>`<first series[{N}, {#}, {ID}]>`<hr>`<first series[{N}, {ID}, {#:00.0}]>`|Sherlock Holmes<hr>Sherlock Holmes<hr>Sherlock Holmes, 1-6, B08376S3R2<hr>Sherlock Holmes, B08376S3R2, 01.0-06.0|
+
+## Series List Formatters
+|Formatter|Description|Example Usage|Example Result|
+|-|-|-|-|
+|separator()|Speficy the text used to join<br>multiple series names.<br><br>Default is ", "|`<series[separator(; )]>`|Sherlock Holmes; Some Other Series|
+|format(\{N \| # \| ID\})|Formats the series properties<br>using the name series tags.<br>See [Series Formatter Usage](#series-formatters) above.|`<series[format({N}, {#})`<br>`separator(; )]>`<hr>`<series[format({ID}-{N}, {#:00.0})]>`|Sherlock Holmes, 1-6; Book Collection, 1<hr>B08376S3R2-Sherlock Holmes, 01.0-06.0, B000000000-Book Collection, 01.0|
+|max(#)|Only use the first # of series<br><br>Default is all series|`<series[max(1)]>`|Sherlock Holmes|
+
+## Name Formatters
+|Formatter|Description|Example Usage|Example Result|
+|-|-|-|-|
+|\{T \| F \| M \| L \| S \| ID\}|Formats the human name using<br>the name part tags.<br>\{T\} = Title (e.g. "Dr.")<br>\{F\} = First name<br>\{M\} = Middle name<br>\{L\} = Last Name<br>\{S\} = Suffix (e.g. "PhD")<br>\{ID\} = Audible Contributor ID<br><br>Default is \{P\} \{F\} \{M\} \{L\} \{S\}|`<first narrator[{L}, {F}]>`<hr>`<first author[{L}, {F} _{ID}_]>`|Fry, Stephen<hr>Doyle, Arthur \_B000AQ43GQ\_;<br>Fry, Stephen \_B000APAGVS\_|
+
+## Name List Formatters
+|Formatter|Description|Example Usage|Example Result|
+|-|-|-|-|
+|separator()|Speficy the text used to join<br>multiple people's names.<br><br>Default is ", "|`<author[separator(; )]>`|Arthur Conan Doyle; Stephen Fry|
+|format(\{T \| F \| M \| L \| S \| ID\})|Formats the human name using<br>the name part tags.<br>See [Name Formatter Usage](#name-formatters) above.|`<author[format({L}, {F})`<br>`separator(; )]>`<hr>`<author[format({L}, {F}`<br>`_{ID}_) separator(; )]>`|Doyle, Arthur; Fry, Stephen<hr>Doyle, Arthur \_B000AQ43GQ\_;<br>Fry, Stephen \_B000APAGVS\_|
+|sort(F \| M \| L)|Sorts the names by first, middle,<br>or last name<br><br>Default is unsorted|`<author[sort(M)]>`|Stephen Fry, Arthur Conan Doyle|
+|max(#)|Only use the first # of names<br><br>Default is all names|`<author[max(1)]>`|Arthur Conan Doyle|
+
+## Number Formatters
+For more custom formatters and examples, [see this guide from Microsoft](https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-numeric-format-strings).
+|Formatter|Description|Example Usage|Example Result|
+|-|-|-|-|
+|\[integer\]|Zero-pads the number|\<bitrate\[4\]\><br>\<series#\[3\]\><br>\<samplerate\[6\]\>|0128<br>001<br>044100|
+|0|Replaces the zero with the corresponding digit if one<br>is present; otherwise, zero appears in the result string.|\<series#\[000.0\]\>|001.0|
+|#|Replaces the "#" symbol with the corresponding digit if one<br> is present; otherwise, no digit appears in the result string|\<series#\[00.##\]\>|01|
+
+## Date Formatters
+Form more standard formatters, [see this guide from Microsoft](https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings).
+### Standard DateTime Formatters
+|Formatter|Description|Example Usage|Example Result|
+|-|-|-|-|
+|s|Sortable date/time pattern.|\<file date[s]\>|2023-02-14T13:45:30|
+|Y|Year month pattern.|\<file date[Y]\>|February 2023|
+
+### Custom DateTime Formatters
+You can use custom formatters to construct customized DateTime string. For more custom formatters and examples, [see this guide from Microsoft](https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings).
+|Formatter|Description|Example Usage|Example Result|
+|-|-|-|-|
+|yyyy|4-digit year|\<file date[yyyy]\>|2023|
+|yy|2-digit year|\<file date[yy]\>|23|
+|MM|2-digit month|\<file date[MM]\>|02|
+|dd|2-digit day of the month|\<file date[yyyy-MM-dd]\>|2023-02-14|
+|HH<br>mm|The hour, using a 24-hour clock from 00 to 23<br>The minute, from 00 through 59.|\<file date[HH:mm]\>|14:45|
+
+

docs/features/searching-and-filtering.md

@@ -0,0 +1,66 @@
+
+# Searching and filtering
+
+### Tags
+
+To add tags to a title, click the tags button
+
+![Tags step 1](../images/Tags1.png)
+
+Add as many tags as you'd like. Tags are separated by a space. Each tag can contain letters, numbers, and underscores
+
+![Tags step 2](../images/Tags2.png)
+
+Tags are saved non-case specific for easy search. There is one special tag "hidden" which will also grey-out the book
+
+![Tags step 3](../images/Tags3.png)
+
+To edit tags, just click the button again.
+
+### Searches
+
+Libation's advanced searching is built on the powerful Lucene search engine. Simple searches are effortless and powerful searches are simple. To search, just type and click Filter or press enter
+
+* Type anything in the search box to search common fields: title, authors, narrators, and the book's audible id
+* Use Lucene's "Query Parser Syntax" for advanced searching.
+    * Easy tutorial: http://www.lucenetutorial.com/lucene-query-syntax.html
+    * Full official guide: https://lucene.apache.org/core/2_9_4/queryparsersyntax.html
+* Tons of search fields, specific to audiobooks
+* Synonyms so you don't have to memorize magic words. Eg: author and author**s** will both work
+* Click [?] button for a full list of search fields and synonyms ![Filter options](../images/FilterOptionsButton.png)
+* Search by tag like \[this\]
+* When tags have an underscore you can use part of the tag. This is useful for quick categories. The below examples make this more clear.
+
+### Search examples
+
+Search for anything with the word potter
+
+![Search example: potter](../images/SearchExamplePotter.png)
+
+If you only want to see Harry Potter
+
+![Search example: "harry potter"](../images/SearchExampleHarryPotter.png)
+
+If you only want to see potter except for Harry Potter. You can also use "-" instead of "NOT"
+
+![Search example: "potter NOT harry"](../images/SearchExamplePotterNotHarry.png)
+![Search example: "potter -harry"](../images/SearchExamplePotterNotHarry2.png)
+
+To see only books written by Neil Gaiman where he also narrates his own book. (If you don't include AND, you'll see everything written by Neil Gaiman and also all books in your library which are self-narrated.)
+
+![Search example: author:gaiman AND authornarrated](../images/SearchExampleGaimanAuthorNarrated.png)
+
+I tagged autobiographies as auto_bio and biographies written by someone else as bio. I can get only autobiographies with \[auto_bio\] or get both by searching \[bio\]
+
+![Search example: \[bio\]](../images/SearchExampleBio.png)
+![Search example: \[auto_bio\]](../images/SearchExampleAutoBio.png)
+
+### Filters
+
+If you have a search you want to save, click Add To Quick Filters to save it in your Quick Filters list. To use it again, select it from the Quick Filters list.
+
+To edit this list go to Quick Filters > Edit quick filters. Here you can re-order the list, delete filters, double-click a filter to edit it, or double-click the bottom blank box to add a new filter.
+
+Check "Quick Filters > Start Libation with 1st filter Default" to have your top filter automatically applied when Libation starts. In this top example, I want to always start without these: at books I've tagged hidden, books I've tagged as free_audible_originals, and books which I have rated.
+
+![default filters](../images/FiltersDefault.png)

docs/frequently-asked-questions.md

@@ -0,0 +1,52 @@
+# Frequently Asked Questions
+
+## Where can I get help for my specific problem?
+
+You can open an issue here for bug reports, feature requests, or specialized help.
+
+## What's the difference between 'Classic' and 'Chardonnay'?
+
+First and most importantly: Classic and Chardonnay have the exact same features.
+
+- **Classic** is Windows only. Its older 'grey boxes' look has a compact design which allows for more information on the screen. Notably, Classic was written using an older, more mature technology which has built-in support for screenreaders.
+
+- **Chardonnay** is available for Windows, Mac, and Linux. Its modern design has a more open look and feel.
+
+## Now that I've downloaded my books, how can I listen to them?
+
+You can use any app which plays m4b files (or mp3 files if you used that setting). Here are just a few ideas. Disclaimer: I have no affiliation with any of these companies:
+
+- iOS: [BookPlayer](https://apps.apple.com/us/app/bookplayer/id1138219998)
+- iOS: [Bound](https://apps.apple.com/us/app/bound-audiobook-player/id1041727137)
+- Android: [Smart AudioBook Player](https://play.google.com/store/apps/details?id=ak.alizandro.smartaudiobookplayer&hl=en_US&gl=US)
+- Android: [Listen](https://play.google.com/store/apps/details?id=ru.litres.android.audio&hl=en_US&gl=US)
+- Desktop: [VLC](https://www.videolan.org/)
+- Windows Desktop: [Audibly](https://github.com/rstewa/Audibly) -- a desktop player build specifically for audiobooks
+
+Self-hosting online:
+
+- [audiobookshelf](https://www.audiobookshelf.org). On [reddit](https://www.reddit.com/r/audiobookshelf/)
+- [plex](https://www.plex.tv/). Listen with [Prologue](https://prologue.audio/) (iOS)
+
+## I'm having trouble playing my non-spatial audiobook, how can I fix this?
+
+If you enabled the [Request xHE-AAC Codec](./features/audio-file-formats.md#request-xhe-aac-codec) option in settings, then the audiobook is being downloaded in the [xHE-AAC codec](./features/audio-file-formats.md#xhe-aac) which isn't widely supported. You have two options:
+
+1. Use a media player which supports the xHE-AAC codec. [See an incomplete list of media players which support xHE-AAC](./features/audio-file-formats.md#supported-media-players).
+2. Disable the [Request xHE-AAC Codec](./features/audio-file-formats.md#request-xhe-aac-codec) option in settings and re-download the audiobook. This will cause Libation to download audiobooks in the [AAC-LC codec](./features/audio-file-formats.md#aac-lc), which enjoys near-universal media player support.
+
+## I'm having trouble playing my book with 4D, spatial audio, or Dolby Atmos, how can I fix this?
+
+Spatial audiobooks are delivered in two formats: [E-AC-3](./features/audio-file-formats.md#e-ac-3) and [AC-4](./features/audio-file-formats.md#ac-4). [See an incomplete list of media players which support those codecs](./features/audio-file-formats.md#supported-media-players).
+
+## I'm having trouble loggin into my Brazil account.
+
+For reasons known only to Jeff Bezos and God, amazon and audible brazil handle logins slightly differently. The external browser login option is not possible for Brazil. [See this ticket for more details.](https://github.com/rmcrackan/Libation/issues/1103)
+
+## How do I use Libation with a South Africa account?
+
+Like many countries, amazon gives South Africa it's own amazon site. [Unlike many other regions](https://www.audible.com/ep/country-selector) there is not South Africa specific audible site. Use `US` for your region -- ie: audible.com.
+
+::: info
+(Not exactly a _frequently_ asked question but it's come up more than once)
+:::

docs/images/libation_glass.svg

@@ -0,0 +1,50 @@
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 288 288" enable-background="new 0 0 288 288">
+	<style>
+		.glass-fill { fill: #000000; }
+		.glass-stroke { stroke: rgba(255, 255, 255, 0.3); }
+		
+		@media (prefers-color-scheme: dark) {
+			.glass-fill { fill: #ffffff; }
+			.glass-stroke { stroke: rgba(0, 0, 0, 0.3); }
+		}
+	</style>
+	<defs>
+		<g id="glass">
+			<path transform="translate(16 16)" fill-rule="evenodd" d=
+				"M177,16
+					H79
+					A 32.0781 63.7932 -1.5106 0 0 66 80
+					A 158.789 471.1259 41.9466 0 0 90 131
+					A 81.7197 122.0515 35.3745 0 0 128 143.3484
+					A 81.7197 122.0515 -35.3745 0 0 166 131
+					A 158.789 471.1259 -41.9466 0 0 190 80
+					A 32.0781 63.7932 1.5106 0 0 177 16
+					L 184 0
+					A 44.7901 78.5247 1.1521 0 1 194 122
+					A 97.0039 135.3148 -36.2124 0 1 136 159
+					V 240
+					H 176
+					A 8 8 0 0 1 176 256
+					H 80
+					A 8 8 0 0 1 80 240
+					H 120
+					V 159					
+					A 97.0039 135.3148 36.2124 0 1 62 122
+					A 44.7901 78.5247 -1.1521 0 1 72 0
+					H184
+				z"/>
+		</g>
+		<g transform="translate(16 16)" id="wine-level">
+			<path d=
+				"M182,64
+					H 74
+					A 115.9979 308.8033 38.9474 0 0 128 134.4277
+					A 115.9979 308.8033 -38.9474 0 0 182,64
+				z"/>
+		</g>
+	</defs>	
+	<use href="#glass" class="glass-stroke" stroke-width="16" fill="Transparent" />
+	<use href="#wine-level" class="glass-stroke" stroke-width="16" fill="Transparent" />
+	<use href="#glass" class="glass-fill" />
+	<use href="#wine-level" class="glass-fill" />
+</svg>

docs/index.md

@@ -0,0 +1,139 @@
+# Getting started
+
+## Installation
+
+Download the [latest version of Libation](https://github.com/rmcrackan/Libation/releases)
+
+### Which version? Chardonnay vs Classic
+
+Nearly 100% of the difference is look and feel -- it's a matter of preference.
+
+**Chardonnay** has an updated look and will work and look the same on Windows, Mac, and Linux.
+
+**Classic** is Windows only. It has an older look because it's built with older, duller, and more mature technology. This tech has built into it better support for things like accessibility for screen readers.
+
+### Platform-specific instructions
+
+- Windows
+
+Extract the zip file to a folder and then run `Libation.exe` from inside of that folder. Do not put it in Program Files. The inability to edit files from there causes problems with configuration and updating.
+
+- [Linux](./installation/install-on-linux.md)
+- [MacOS](./installation/install-on-mac.md)
+
+## Create Accounts
+
+Create your account(s):
+
+![Create your accounts, menu](images/v40_accounts.png)
+
+New locale options include many more regions including old audible accounts which pre-date the amazon acquisition
+
+![Choose your account locales](images/v40_locales.png)
+
+## Import your library
+
+Be default, Libation will periodically scan the accounts you added above with a checkbox next to them. Nothing for you to do. You can also scan manually.
+
+Select Import > Scan Library:
+
+![Import step 1](images/Import1.png)
+
+Or if you have multiple accounts, you'll get to choose whether to scan all accounts or just the ones you select:
+
+![Import which accounts](images/v40_import.png)
+
+If this is a new installation, or you're scanning an account you haven't scanned before, you'll be prompted to enter your password for the Audible account.
+
+![Login password](images/alt-login1.png)
+
+Enter the password and click Submit. Audible will prompt you with a CAPTCHA image.
+
+![Login captcha](images/alt-login2.png)
+
+Enter the CAPTCHA answer characters and click Submit. If all has gone well, Libation will start scanning the account.
+
+In rare instances, the Captcha image/response will fail in an endless loop. If this happens, delete the problem account, and then click Save. Re-add the account and click Save again. Now try to scan the account again. This time, instead of typing your password, click the link that says "Or click here". This will open the Audible External Login dialog shown below.
+
+![Login alternative setup](images/alt-login3.png)
+
+You can either copy the URL shown and paste it into your browser or launch the browser directly by clicking Launch in Browser. Audible will display its standard login page. Login, including answering the CAPTCHA on the next page. In some cases, you might have to approve the login from the email account associated with that login, but once the login is successful, you'll see an error message.
+
+![Login alternative login result](images/alt-login4.png)
+
+This actually means you've successfully logged in. Copy the entire URL shown in your browser and return to Libation. Paste that URL into the text box at the bottom of the Audible External Login window and click Submit.
+
+You'll see this window while it's scanning:
+
+![Import step 2](images/Import2.png)
+
+Success! We see how many new titles are imported:
+
+![Import step 3](images/Import3.png)
+
+## Download your books -- DRM-free!
+
+Automatically download some or all of your audible books. This shows you how much of your library is not yet downloaded and decrypted:
+
+The stoplights will tell you a title's status:
+
+- Green: downloaded and decrypted
+- Yellow: downloaded but still encrypted with DRM
+- Red: not downloaded
+- PDF icon without arrow: downloaded
+- PDF with arrow: not downloaded
+
+Or hover over the button to see the status.
+
+![Liberate book step 1](images/LiberateBook1.png)
+
+Select Liberate > Begin Book Backups
+
+You can also click on the stop light to download only that title and its PDF
+
+![Liberate book step 2](images/LiberateBook2.png)
+
+First the original book with DRM is downloaded
+
+![Liberate book step 3](images/LiberateBook3.png)
+
+Then it's decrypted so you can use it on any device you choose. The very first time you decrypt a book, this step will take a while. Every other book will go much faster. The first time, Libation has to figure out the special decryption key which allows your personal books to be unlocked.
+
+![Liberate book step 4](images/LiberateBook4.png)
+
+And voila! If you have multiple books not yet liberated, Libation will automatically move on to the next.
+
+![Liberate book step 5](images/LiberateBook5.png)
+
+The Audible id must be somewhere in the book's file or folder name for Libation to detect your downloaded book.
+
+## Download PDF attachments
+
+For books which include PDF downloads, Libation can download these for you as well and will attempt to store them with the book. "Book backup" will already download an available PDF. This additional option is useful when Audible adds a PDF to your book after you've already backed it up.
+
+Select Liberate > Begin PDF Backups
+
+![PDF download step 2](images/PdfDownload2.png)
+
+The downloads work just like with books, only with no additional decryption needed.
+
+![PDF download step 3](images/PdfDownload3.png)
+
+## Details of downloaded files
+
+![Post download](images/PostDownload.png)
+
+When you set up Libation, you'll specify a Books directory. Libation looks inside that directory and all subdirectories to look for files or folders with each library book's audible id. This way, organization is completely up to you. When you download + decrypt a book, you get several files
+
+- .m4b: your audiobook in m4b format. This is the most pure version of your audiobook and retains the highest quality. Now that it's decrypted, you can play it on any audio player and put it on any device. If you'd like, you can also use 3rd party tools to turn it into an mp3. The freedom to do what you want with your files was the original inspiration for Libation.
+- .cue: this is a file which logs where chapter breaks occur. Many tools are able to use this if you want to split your book into files along chapter lines.
+
+## Export your library
+
+![Export](images/Export.png)
+
+Export your library to Excel, CSV, or JSON
+
+## I still need help
+
+[You can open an issue here](https://github.com/rmcrackan/Libation/issues) for bug reports, feature requests, or specialized help.

docs/installation/docker.md

@@ -0,0 +1,80 @@
+# Docker Support
+
+> [!WARNING] Breaking Changes
+> - The docker image now runs as user 1001 and group 1001. Make sure that the permissions on your volumes allow user 1001 to read and write to them or see the User section below for other options, or if you're not sure.
+> - `SLEEP_TIME` is now set to `-1` by default. This means the image will run once and exit. If you were relying on the previous default, you'll need to explicitly set the `SLEEP_TIME` environment variable to `30m` to replicate the previous behavior.
+> - The docker image now ignores the values in `Settings.json` for `Books` and `InProgress`. You can now change the folder that books are saved to by using the `LIBATION_BOOKS_DIR` environment variable.
+
+# Disclaimer
+
+The docker image is provided as-is. We hope it can be useful to you but it is not officially supported.
+
+### Configuration
+
+Configuration in Libation is handled by two files, `AccountsSettings.json` and `Settings.json`. These files can usually be found in the Libation folder in your user's home directory. The easiest way to configure these is to run the desktop version of Libation and then copy them into a folder, such as `/opt/libation/config`, that you'll volume mount into the image. `Settings.json` is technically optional, and, if not provided, Libation will run using the default settings. Additionally, the `Books` and `InProgress` settings in `Settings.json` will be ignored and the image will instead substitute it's own values.
+
+### Running
+
+Once the configuration files are copied, the docker image can be run with the following command.
+
+```
+sudo docker run -d \
+  -v /opt/libation/config:/config \
+  -v /opt/libation/books:/data \
+  --name libation \
+  --restart=always \
+  rmcrackan/libation:latest
+```
+
+By default the container will scan for new books once and download any new ones. This is configurable by passing in a value for the `SLEEP_TIME` environment variable. For example, if you pass in `10m` it will keep running, scan for new books, and download them every 10 minutes.
+
+```
+sudo docker run -d \
+  -v /opt/libation/config:/config \
+  -v /opt/libation/books:/data \
+  -e SLEEP_TIME='10m' \
+  --name libation \
+  --restart=always \
+  rmcrackan/libation:latest
+```
+
+### Environment Variables
+
+| Env Var             | Default | Description                                                                                                           |
+| ------------------- | ------- | --------------------------------------------------------------------------------------------------------------------- |
+| SLEEP_TIME          | -1      | Length of time to sleep before doing another scan/download. Set to -1 to run one.                                     |
+| LIBATION_BOOKS_DIR  | /data   | Folder where books will be saved                                                                                      |
+| LIBATION_CONFIG_DIR | /config | Folder to read configuration from.                                                                                    |
+| LIBATION_DB_DIR     | /db     | Optional folder to load database from. If not mounted, will load database from `LIBATION_CONFIG_DIR`.                 |
+| LIBATION_DB_FILE    |         | Name of database file to load. By default it will look for all `.db` files and load one if there is only one present. |
+| LIBATION_CREATE_DB  | true    | Whether or not the image should create a database file if none are found.                                             |
+
+### User
+
+This docker image runs as user `1001`. In order for the image to function properly, user `1001` must be able to read and write the volumes that are mounted in. If they are not, you will see errors, including [sqlite error](#1060), [Microsoft.Data.Sqlite.SqliteException](#1110), [unable to open database file](#1113), [Microsoft.EntityFrameworkCore.DbUpdateException](#1049)
+
+If you're not sure what your user number is, check the output of the `id` command. Docker should normally run with the number of the user who configured and ran it.
+
+If you want to change the user the image runs as, you can specify `-u <uid>:<gid>`. For example, to run it as user `2000` and group `3000`, you could do the following:
+
+```
+sudo docker run -d \
+  -u 2000:3000 \
+  -v /opt/libation/config:/config \
+  -v /opt/libation/books:/data \
+  --name libation \
+  --restart=always \
+  rmcrackan/libation:latest
+```
+
+If the user it's running as is correct, and it still cannot write, be sure to check whether the files and/or folders might be owned by the wrong user. You can use the `chown` command to change the owner of the file to the correct user and group number, for example: `chown -R 1001:1001 /mnt/audiobooks /mnt/libation-config`
+
+### Advanced Database Options
+
+The docker image supports an optional database mount location defined by `LIBATION_DB_DIR`. This allows the database to be mounted as read/write, while allowing the rest of the configuration files to be mounted as read only. This is specifically useful if running in Kubernetes where you can use Configmaps and Secrets to define the configuration. If the `LIBATION_DB_DIR` is mounted, it will be used, otherwise it will look for the database in `LIBATION_CONFIG_DIR`. If it does not find the database in the expected location, it will attempt to make an empty database there.
+
+### Getting help
+
+As mentioned above: docker is not officially supported. I'm adding this at the bottom of the page for anyone serious enough to have read this far. If you've tried everything above and would still like help, you can open an [issue](https://github.com/rmcrackan/Libation/issues). Please include `[docker]` in the title. There are also some docker folks who have offered occasional assistance who you can tag within your issue: `@ducamagnifico` , `@wtanksleyjr` , `@CLHatch`.
+
+**Reminder** that these are just friendly users who are sometimes around. They're _not_ our customer support.

docs/installation/install-on-linux.md

@@ -0,0 +1,63 @@
+# Install on Linux
+
+## Packaging status
+
+[![Packaging status](https://repology.org/badge/vertical-allrepos/libation.svg)](https://repology.org/project/libation/versions)
+
+New Libation releases are automatically packed into `.deb` and `.rpm` package and are available from the [Libation repository's releases page](https://github.com/rmcrackan/Libation/releases).
+
+Run these commands in your terminal to download and install Libation. **Make sure you replace** `X.X.X` with the latest Libation version and `ARCH` with your CPU's architechture (either `amd64` or `arm64`).
+
+### Debian
+  ```Console
+  wget -O libation.deb https://github.com/rmcrackan/Libation/releases/download/vX.X.X/Libation.X.X.X-linux-chardonnay-ARCH.deb
+  sudo apt install ./libation.deb
+  ```
+### Redhat and CentOS
+  ```Console
+  wget -O libation.rpm https://github.com/rmcrackan/Libation/releases/download/vX.X.X/Libation.X.X.X-linux-chardonnay-ARCH.rpm
+  sudo yum install ./libation.rpm
+  ```
+### Fedora
+  ```Console
+  wget -O libation.rpm https://github.com/rmcrackan/Libation/releases/download/vX.X.X/Libation.X.X.X-linux-chardonnay-ARCH.rpm
+  sudo dnf5 install ./libation.rpm
+  ```
+---
+### Arch Linux
+  ```Console
+  yay -S libation
+  ```
+  This package is available on [Arch User Repository](https://aur.archlinux.org/packages/libation), install via your choice of [AUR helpers](https://wiki.archlinux.org/title/AUR_helpers).
+  
+  Thanks to [mhdi](https://aur.archlinux.org/account/mhdi) for taking care of AUR package maintenance.
+### NixOS
+  - Install via `nix-shell`
+    ```Console
+    nix-shell -p libation
+    ```
+    A `nix-shell` will temporarily modify your $PATH environment variable. This can be used to try a piece of software before deciding to permanently install it.
+  - Install via NixOS configuration
+    ```Console
+    environment.systemPackages = [
+      pkgs.libation
+    ];
+    ```
+    Add the following Nix code to your NixOS Configuration, usually located in `/etc/nixos/configuration.nix`
+  - On NixOS via via `nix-env`
+    ```Console
+    nix-env -iA nixos.libation
+    ```
+  - On Non NixOS via `nix-env`
+    ```Console
+    nix-env -iA nixpkgs.libation
+    ```
+    Warning: Using `nix-env` permanently modifies a local profile of installed packages. This must be updated and maintained by the user in the same way as with a traditional package manager.
+
+    Thanks to [TomaSajt](https://github.com/tomasajt) for taking care of Nix package maintenance.
+
+If your desktop uses gtk, you should now see Libation among your applications.
+
+Additionally, you may launch Libation, LibationCli, and Hangover (the Libation recovery app) via the command line using 'libation, libationcli', and 'hangover' aliases respectively.
+
+Report bugs to https://github.com/rmcrackan/Libation/issues

docs/installation/install-on-mac.md

@@ -0,0 +1,39 @@
+  # Install on MacOS
+
+This walkthrough should get you up and running with Libation on your Mac.
+
+## Supports macOS 13 (Ventura) and above
+
+## Install Libation
+
+- Download the file from the latest release and extract it.
+  - Apple Silicon (M1, M2, ...): `Libation.x.x.x-macOS-chardonnay-`**arm64**`.dmg`
+  - Intel: `Libation.x.x.x-macOS-chardonnay-`**x64**`.dmg`
+- Mount the dmg and open the disk folder (should open automatically). Drag-drop the Libation app into your Applications folder.
+
+  ![macOS-drag-drop-install](../images/macOS-drag-drop-install.png)
+- Go to your applications folder and double-click Libation to start it. The first time you run Libation, you'll be asked if you want to run this program downloaded from the internet. Click "Open".
+
+  ![macOS-libation-first-run](../images/macOS-libation-first-run.png)
+
+
+## Running Hangover
+
+Libation comes with a recovery app called Hangover. You can start it by running this command:
+```Console
+open /Applications/Libation.app --args hangover
+```
+
+## Running LibationCli
+
+Libation comes with a command-line interface. Unfortunately, due to the way apps are sandboxed on mac, its use is somewhat limited. To open a new sandboxed terminal in LibationCli's directory, run the following command:
+```Console
+open /Applications/Libation.app --args cli
+```
+To use LibationCli from an unsandboxed terminal, you must disable gatekeeper again and run the program directly at `/Applications/Libation.app/Contents/MacOS/LibationCli`
+
+Then use `./LibationCli` to execute a command.
+
+## Get Libation running on Mac
+
+[Run Libation on MacOS](https://user-images.githubusercontent.com/37587114/219271379-a922e4e1-48a0-48e4-bd81-48aa1226a4f5.mp4)