From f825bbab2e02573ad72881238934023be1b35e13 Mon Sep 17 00:00:00 2001
From: Robert Dailey <rcdailey@gmail.com>
Date: Sun, 22 May 2022 16:27:48 -0500
Subject: [PATCH] docs: Wiki page for File Structure and document app data
 option

---
 CHANGELOG.md                   |  4 ++++
 wiki/Command-Line-Reference.md |  6 ++++++
 wiki/File-Structure.md         | 19 +++++++++++++++++++
 3 files changed, 29 insertions(+)
 create mode 100644 wiki/File-Structure.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index f89730dd..992eea9f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- New `--app-data` option for overriding the location of the application data directory.
+
 ### Fixed
 
 - Version information in help output has been fixed.
diff --git a/wiki/Command-Line-Reference.md b/wiki/Command-Line-Reference.md
index c56ee975..fbd783f7 100644
--- a/wiki/Command-Line-Reference.md
+++ b/wiki/Command-Line-Reference.md
@@ -91,6 +91,12 @@ By default, Info, Warning and Error log levels are displayed in the console. Thi
 Debug level logs to be displayed. This is designed for debugging and development purposes and
 generally will be too noisy for normal program usage.
 
+### `--app-data`
+
+Overrides the normal, default location of the [[application data directory|File-Structure]]. Note
+that this option is mainly intended for usage in the official Docker image. It is not intended for
+normal use outside of that.
+
 ## Sonarr
 
 ### `--list-release-profiles`
diff --git a/wiki/File-Structure.md b/wiki/File-Structure.md
new file mode 100644
index 00000000..d54d1bda
--- /dev/null
+++ b/wiki/File-Structure.md
@@ -0,0 +1,19 @@
+This page describes the general file structure used by Recyclarr for its data. Many of these are
+platform-specific.
+
+## Application Data Directory
+
+The application data directory is the root location for Recyclarr's files. With the exception of the
+main `recyclarr.yml` file, everything that Recyclarr reads or writes, by default, starts with this
+path.
+
+| Platform | Location                                  |
+| -------- | ----------------------------------------- |
+| Windows  | `%APPDATA%\recyclarr`                     |
+| Linux    | `~/.config/recyclarr`                     |
+| MacOS    | `~/Library/Application Support/recyclarr` |
+
+## Default YAML Configuration File
+
+The default YAML configuration file is `recyclarr.yml` and it is always located next to the
+Recyclarr executable.