Click to expand

\n\n## Example docker-compose usage for AFP\n\n```\ndocker compose -f timemachine-compose.yml up -d\n```\n\n## Example `docker run` usage for AFP\n\nExample usage with `--net=host` to allow Avahi discovery to function:\n\n```\ndocker run -d --restart=always \\\n --net=host \\\n --name timemachine \\\n -e CUSTOM_AFP_CONF=\"false\" \\\n -e CUSTOM_USER=\"false\" \\\n -e LOG_LEVEL=\"info\" \\\n -e MIMIC_MODEL=\"TimeCapsule6,106\" \\\n -e TM_USERNAME=\"timemachine\" \\\n -e TM_GROUPNAME=\"timemachine\" \\\n -e TM_UID=\"1000\" \\\n -e TM_GID=\"1000\" \\\n -e PASSWORD=\"timemachine\" \\\n -e SET_PERMISSIONS=\"false\" \\\n -e SHARE_NAME=\"TimeMachine\" \\\n -e VOLUME_SIZE_LIMIT=\"0\" \\\n -v /path/on/host/to/backup/to/for/timemachine:/opt/timemachine \\\n -v timemachine-netatalk:/var/netatalk \\\n -v timemachine-logs:/var/log/supervisor \\\n mbentley/timemachine:afp\n```\n\nExample usage with exposing ports _without_ Avahi discovery:\n\n```\ndocker run -d --restart=always \\\n --name timemachine \\\n --hostname timemachine \\\n -p 548:548 \\\n -p 636:636 \\\n -e CUSTOM_AFP_CONF=\"false\" \\\n -e CUSTOM_USER=\"false\" \\\n -e LOG_LEVEL=\"info\" \\\n -e MIMIC_MODEL=\"TimeCapsule6,106\" \\\n -e TM_USERNAME=\"timemachine\" \\\n -e TM_GROUPNAME=\"timemachine\" \\\n -e TM_UID=\"1000\" \\\n -e TM_GID=\"1000\" \\\n -e PASSWORD=\"timemachine\" \\\n -e SET_PERMISSIONS=\"false\" \\\n -e SHARE_NAME=\"TimeMachine\" \\\n -e VOLUME_SIZE_LIMIT=\"0\" \\\n -v /path/on/host/to/backup/to/for/timemachine:/opt/timemachine \\\n -v timemachine-netatalk:/var/netatalk \\\n -v timemachine-logs:/var/log/supervisor \\\n mbentley/timemachine:afp\n```\n\nThis works best with `--net=host` so that discovery can be broadcast. Otherwise, you will need to expose the above ports and then you must manually map the share in Finder for it to show up (open `Finder`, click `Shared`, and connect as `afp://hostname-or-ip/TimeMachine` with your TimeMachine credentials).\n\nOptional variables for AFP:\n\n| Variable | Default | Description |\n| :------- | :------ | :---------- |\n| `CUSTOM_AFP_CONF` | `false` | indicates that you are going to bind mount a custom config to `/etc/netatalk/afp.conf` if set to `true` |\n| `CUSTOM_USER` | `false` | indicates that you are going to bind mount `/etc/password`, `/etc/group`, and `/etc/shadow`; and create data directories if set to `true` |\n| `LOG_LEVEL` | `info` | sets the netatalk log level |\n| `MIMIC_MODEL` | `TimeCapsule6,106` | sets the value of time machine to mimic |\n| `TM_USERNAME` | `timemachine` | sets the username time machine runs as |\n| `TM_GROUPNAME` | `timemachine` | sets the group name time machine runs as |\n| `TM_UID` | `1000` | sets the UID of the `TM_USERNAME` user |\n| `TM_GID` | `1000` | sets the GID of the `TM_GROUPNAME` group |\n| `PASSWORD` | `timemachine` | sets the password for the `timemachine` user |\n| `SET_PERMISSIONS` | `false` | set to `true` to have the entrypoint set ownership and permission on `/opt/timemachine` |\n| `SHARE_NAME` | `TimeMachine` | sets the name of the timemachine share to TimeMachine by default |\n| `VOLUME_SIZE_LIMIT` | `0` | sets the maximum size of the time machine backup in MiB ([mebibyte](https://en.wikipedia.org/wiki/Mebibyte)) |\n\n

\n\nThanks for [odarriba](https://github.com/odarriba) and [arve0](https://github.com/arve0) for their examples to start from.\n","has_starred","hub_user","immutable_tags_settings",{"_174":11,"_175":176},"enabled","rules",[177],".*","is_automated","permissions",{"_181":22,"_182":11,"_183":11},"read","write","admin","user","storage_size",34688466973,"isOrg","reponame","tag","sha256:0f1233cbf5a7d88fc68883bb5e2e50cf15cd9f6b05998d59588370e631414327","canDeleteTags","isHubSbxKitsEnabled","currentTab","tagAttestations","displaySecurityMetadata","showSbxLogoOverride","showSbxAgenticPlatformBadge","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)._index",{"_27":28,"_133":-7,"_131":-7,"_132":-7,"_29":200,"_35":190,"_204":-7,"_205":11},{"_31":32,"_33":34,"_35":36,"_37":38,"_39":40,"_41":201,"_67":68,"_69":34,"_70":71,"_72":73,"_74":75,"_76":77,"_78":50,"_79":68,"_80":59,"_81":22},[202,203],{"_44":45,"_35":46,"_47":48,"_49":50,"_51":52,"_53":54,"_55":48,"_56":-5,"_57":38,"_58":59,"_60":-5},{"_44":62,"_35":63,"_47":48,"_49":64,"_51":65,"_53":54,"_55":48,"_56":-5,"_57":66,"_58":59,"_60":-5},"imageWithLayers","hasPermissionToViewRepoSettings","actionData","errors"]

mbentley/timemachine:latest