ansible-nas/docs/applications/timemachine.md

33 lines
2.7 KiB
Markdown
Raw Normal View History

2019-01-08 02:43:55 +00:00
# Time Machine
Apple docs: [https://support.apple.com/en-us/HT201250](https://support.apple.com/en-us/HT201250)
2019-10-19 21:18:07 +00:00
Docker image: [https://github.com/awlx/samba-timemachine](https://github.com/awlx/samba-timemachine)
2019-01-08 02:43:55 +00:00
Time Machine is an application that allows you to backup files from your Mac.
2019-01-08 02:43:55 +00:00
2019-10-19 21:18:07 +00:00
Older versions of Time Machine relied on AFP (netatalk) shares. Apple has deprecated Time Machine over AFP in favor of SMB (Samba), and current versions of Ansible-NAS use a Samba-based Time Machine share. If you are upgrading from an older version of Ansible-NAS, you will need to re-select your Time Machine back up disk by opening Time Machine Preferences and Selecting your backup disk via the "Select Disk..." option. Your Mac will find the old backups on the share and use them.
2019-01-08 02:43:55 +00:00
## Usage
Set `timemachine_enabled: true` in your `group_vars/all.yml` file.
Enabling Time Machine will result in the installation of Avahi on the NAS system (if it is not already installed) and a Time Machine service configuration file for Avahi will be added to the system (at `/etc/avahi/services/timemachine.service`) to allow for Time Machine discovery by Macs on the local network. Avahi runs on the system, rather than in a container, as the same Avahi instance can be used to announce any number of services.
2019-10-19 21:18:07 +00:00
The Samba server included in the Time Machine docker container logs to `STDOUT` and is compatible with [Docker's built-in logging infrastructure.](https://docs.docker.com/config/containers/logging/)
2019-10-19 21:18:07 +00:00
## Specific Configuration
2019-01-08 02:43:55 +00:00
<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>
2019-10-19 21:18:07 +00:00
<dd>The name of the share as it will appear in the Time Machine application. Default is 'Data'</dd>
2019-01-08 02:43:55 +00:00
<dt><strong>timemachine_password</strong></dt>
<dd>The password used to access the share. Default is 'timemachine'</dd>
2019-10-20 21:52:52 +00:00
<dl>
## Upgrading from AFP to SMB-based Time Machine
Older versions of Time Machine included in Ansible-NAS relied on AFP (netatalk) shares. Apple has deprecated Time Machine over AFP in favor of SMB (Samba), and current versions of Ansible-NAS use a Samba-based Time Machine share. If you are upgrading from an older version of Ansible-NAS with the AFP-based Time Machine, you will need to re-select your Time Machine back up disk by opening Time Machine Preferences and Selecting your backup disk via the "Select Disk..." option. Your Mac will find the old backups on the share and use them.