mirror of
https://github.com/davestephens/ansible-nas
synced 2024-12-25 11:03:07 +00:00
Add docs
This commit is contained in:
parent
0504337273
commit
2188c8d329
2 changed files with 25 additions and 0 deletions
|
@ -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
|
||||
|
|
24
docs/applications/timemachine.md
Normal file
24
docs/applications/timemachine.md
Normal file
|
@ -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>
|
Loading…
Reference in a new issue