From 2188c8d329c02605f89b4ea837f3821cee871c25 Mon Sep 17 00:00:00 2001
From: Jesse Goerz <jgoerz@cfl.rr.com>
Date: Mon, 7 Jan 2019 21:43:55 -0500
Subject: [PATCH] Add docs

---
 README.md                        |  1 +
 docs/applications/timemachine.md | 24 ++++++++++++++++++++++++
 2 files changed, 25 insertions(+)
 create mode 100644 docs/applications/timemachine.md

diff --git a/README.md b/README.md
index b7abc18c..6f6577c1 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,7 @@ just a stock Ubuntu install, some clever Ansible config and a bunch of Docker co
 * [Sonarr](https://sonarr.tv/) - for downloading and managing TV episodes
 * [Tautulli](http://tautulli.com/) - Monitor Your Plex Media Server
 * [Telegraf](https://github.com/influxdata/telegraf) - Metrics collection agent
+* [TimeMachine](https://github.com/mbentley/docker-timemachine) - Mac backup server
 * [Traefik](https://traefik.io/) - Web proxy and SSL certificate manager
 * [Transmission](https://transmissionbt.com/) - BitTorrent client (with OpenVPN if you have a supported VPN provider)
 * [Watchtower](https://github.com/v2tec/watchtower) - Monitor your Docker containers and update them if a new version is available
diff --git a/docs/applications/timemachine.md b/docs/applications/timemachine.md
new file mode 100644
index 00000000..65d33a13
--- /dev/null
+++ b/docs/applications/timemachine.md
@@ -0,0 +1,24 @@
+# Time Machine
+
+Apple docs: [https://support.apple.com/en-us/HT201250](https://support.apple.com/en-us/HT201250)
+Docker image: [https://github.com/mbentley/docker-timemachine](https://github.com/mbentley/docker-timemachine)
+
+Time Machine is an application that allows you to backup files from you Mac.
+
+## Usage
+
+Set `timemachine_enabled: true` in your `group_vars/all.yml` file.
+
+Set the Time Machine specific variables:
+
+<dl>
+  <dt><strong>timemachine_data_directory</strong></dt>
+  <dd>The absolute path on Ansible NAS where the backup files will be stored</dd>
+  <dt><strong>timemachine_volume_size_limit</strong></dt>
+  <dd>The maximum amount of space Time Machine can use for the backups in units of MiB.  Set it to 0 for no limit.</dd>
+  <dt><strong>timemachine_share_name</strong></dt>
+  <dd>The name of the share as it will appear in the Time Machine application. Default is 'TimeMachine'</dd>
+  <dt><strong>timemachine_password</strong></dt>
+  <dd>The password used to access the share.  Default is 'timemachine'</dd>
+  <dt><strong>timemachine_log_level</strong></dt>
+  <dd>The verbosity of the logs.  'Error' is the default.</dd>