mbentley / docker-timemachine

Docker image to run Samba (compatible Time Machine for macOS)
Apache License 2.0
527 stars 65 forks source link

[Bug/Help]: README suggestion #159

Closed jamess60 closed 6 months ago

jamess60 commented 6 months ago

Describe the Bug

README doesn't make it super obvious that the backup path (default /opt/timemachine) is tied to the TM_USER variable. During my first backup, I filled my docker host root instead of my backup volume because my mount was incorrect.

Expected Behavior

README should be tweaked in a way that makes it slightly more apparent that the /opt/xxx backup path mirrors the TM_USER env

Steps to Reproduce

  1. Setup the container with the volume mapped to /opt/timemachine with a none default username
  2. Backup

How You're Launching the Container

timemachine:
        image: mbentley/timemachine:latest
        container_name: timemachine
        volumes:
            - /timemachine:/opt/netadmin
        environment:
            - TM_USERNAME=netadmin
            - TM_GROUPNAME=timemachine
            - PASSWORD=ITS A SECRET
            - TM_UID=1000
            - TM_GID=1000
            - SET_PERMISSIONS=false
            - VOLUME_SIZE_LIMIT="0"
            - SHARE_NAME=TimeMachine
        restart: always
        privileged: true
        network_mode: "host"

Container Logs

Not
Applicable

Time Machine client Logs

No response

Additional Context

No additional context but awesome image, keep up the good work :)

mbentley commented 6 months ago

It's specifically called out here but I guess that may need to be moved up higher or something if it isn't obvious.

jamess60 commented 6 months ago

My bad! I did indeed miss that, apologies! Yeah, possibly worth moving it up or making it bigger.

Thanks again :)

mbentley commented 6 months ago

Added a warning note up by the examples to link down further. Appreciate the feedback!