servercontainers/samba repository overview

⁠samba - (ghcr.io/servercontainers/samba) [x86 + arm]

samba on alpine

with timemachine, zeroconf (avahi) and WSD (Web Services for Devices) (wsdd2) support.

⁠IMPORTANT!

New Registry: ghcr.io/servercontainers/samba

In March 2023 - Docker informed me that they are going to remove my organizations servercontainers and desktopcontainers unless I'm upgrading to a pro plan.

I'm not going to do that. It's more of a professionally done hobby then a professional job I'm earning money with.

In order to avoid bad actors taking over my org. names and publishing potenial backdoored containers, I'd recommend to switch over to my new github registry: ghcr.io/servercontainers.

⁠Build & Variants

You can specify DOCKER_REGISTRY environment variable (for example my.registry.tld) and use the build script to build the main container and it's variants for x86_64, arm64 and arm

You'll find all images tagged like a3.15.0-s4.15.2 which means a<alpine version>-s<samba version>. This way you can pin your installation/configuration to a certian version. or easily roll back if you experience any problems.

To build a latest tag run ./build.sh release

For builds without specified registry you can use the generate-variants.sh script to generate variations of this container and build the repos yourself.

all of those variants are automatically build and generated in one go

• latest or a<alpine version>-s<samba version>
  • main version of this repo
  • includes everything (smbd, avahi, wsdd2)
  • not all services need to start/run -> use ENV variables to disable optional services
• smbd-only-latest or smbd-only-a<alpine version>-s<samba version>
  • this will only include smbd and my scripts - no avahi, wsdd2 installed
• smbd-avahi-latest or smbd-avahi-a<alpine version>-s<samba version>
  • this will only include smbd, my scripts and avahi
  • optional service can still be disabled using ENV variables
• smbd-wsdd2-latest or smbd-wsdd2-a<alpine version>-s<samba version>
  • this will only include smbd, my scripts and wsdd2
  • optional service can still be disabled using ENV variables

⁠Changelogs

• 2023-03-20
  • github action to build container
  • implemented ghcr.io as new registry
• 2023-03-15
  • switched from docker hub to a build-yourself container
• 2023-02-06
  • fixed capitalization of username while hashing - convert to lowercase
• 2022-12-05
  • fixed SAMBA_GLOBAL_CONFIG_... with colon in the key.
• 2022-05-31
  • support for server role as ENV parameter
• 2022-01-31
  • support for global settings via stanza (similar to volume config)
• 2022-01-28
  • removed old chmod 777, chown nodboy:nogroup statements on multi user shares
• 2022-01-20
  • fixed healthcheck for container avahi
• 2022-01-08
  • better build script
• 2021-12-30
  • fix for disabling wsdd2
  • verbose execution of service start
  • log to stdout
  • fixed connection issues by pinning alpine to 3.14
  • made avahi optional
  • new build process and variants
• 2021-12-25
  • multi user shares for all volumes possible
  • removed bash to same some space
  • improved docker-compose.yml
  • improved healthcheck
  • improved logging
• 2021-12-24
  • start smbd with --foreground parameter
  • fix for loglevel settings - it works now
  • new examples for shared shares in docker-compose.yml
  • start wsdd2 after 10 seconds
• 2021-12-02
  • made wsdd2 service optional
  • updated version
• 2021-09-27
  • added support for wsdd2 parameterization
• 2021-08-30
  • added support for groups
• 2021-08-27
  • removed old multi arch build dockerfiles - builx is used
  • added wsdd2 for service discovery on windows
• 2021-08-23
  • fixed SAMBA_GLOBAL_CONFIG_... missing key.
• 2021-08-08
  • added env to contorl log level - default value 1
  • fixed SAMBA_GLOBAL_CONFIG_... with spaces in the key.
• 2021-03-16
  • added support for specifing the uid for each ACCOUNT_ using UID_username=1234214 env.
• 2021-03-09
  • updated healthcheck to work with external avahi server
• 2020-12-22
  • added support for samba password hashes instead of just plaintext passwords
• 2020-12-10
  • added Timemachine Multiuser Support (samba config path needs to end with %U)
• 2020-12-09
  • bug fix: </service-group> gets removed with multiple timemachine volumes
• 2020-11-08
  • fixed samba user creation
  • custom avahi service name
• 2020-11-05
  • multiarch build
  • rewrite from debian to alpine
  • enhanced timemachine support

⁠Info

This is a Samba Server Container running on _/alpine.

⁠Environment variables and defaults

⁠Samba

• SAMBA_GLOBAL_STANZA

  • optional
  • default not set
  • use it to manage multiple global settings in one place
  • seperate multiple settings/lines using ; which will be automatically translated to \n

• SAMBA_GLOBAL_CONFIG_someuniquevalue

  • add any global samba config to smb.conf
  • example value: key = value
  • important if the SAMBA key contains a space replace it with _SPACE_
    • e.g. foo_SPACE_bar
  • important if the SAMBA key contains a : space replace it with _COLON_
    • e.g. foo_COLON_bar

• ACCOUNT_username

  • multiple variables/accounts possible
  • adds a new user account with the given username and the env value as password or samba hash
    • either you add a simple plaintext password as value (can't start with :username:[0-9]*: or it will be detected as hash)
    • to add a samba hash e.g. user:1002:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:8846F7EAEE8FB117AD06BDD830B7586C:[U ]:LCT-5FE1F7DF: (user: user / password: password) add the line from /var/lib/samba/private/smbpasswd
    • create hash using this command docker run -ti --rm --entrypoint create-hash.sh servercontainers/samba
    • see docker-compose.yml user foo for an example how it's used/configured.
    • the hashing script needs an all lowercase username - it will therefore automatically lowercase given username
  • to restrict access of volumes you can add the following to your samba volume config:
    • valid users = alice; invalid users = bob;

• UID_username

  • optional
  • specify the uid explicitly for each user account.
  • the username part must match to a specified ACCOUNT_username environment variable

• GROUP_groupname

  • optional
  • value will be gid
  • example: GROUP_devops=1500 will create group devops with id 1500

• GROUPS_username

  • optional
  • additional groups for the user
  • to create groups look at GROUP_groupname or mount/inject /etc/groups file (can cause problems)
  • the username part must match to a specified ACCOUNT_username environment variable
  • one or more groups to add seperated by a ,
  • example: GROUPS_johndoe=musican,devops

• MODEL

  • optional model value of avahi samba service
  • default: TimeCapsule
  • some available options are Xserve, PowerBook, PowerMac, Macmini, iMac, MacBook, MacBookPro, MacBookAir, MacPro, MacPro6,1, MacPro7,1 (Tower), MacPro7,1@ECOLOR=226,226,224 (Rack), TimeCapsule, AppleTV1,1 and AirPort.

• AVAHI_NAME

  • optional name of avahi samba service
  • default: hostname

• AVAHI_DISABLE

  • optional
  • default not set - set to any value to disable avahi Service

• SAMBA_CONF_SERVER_ROLE

  • default: standalone server
  • note: $ is an invalid symbol in this env

• SAMBA_CONF_LOG_LEVEL

  • default: 1

• SAMBA_CONF_WORKGROUP

  • default: WORKGROUP

• SAMBA_CONF_SERVER_STRING

  • default: Samba Server

• SAMBA_CONF_MAP_TO_GUEST

  • default: Bad User

• SAMBA_VOLUME_CONFIG_myconfigname

  • adds a new samba volume configuration
  • multiple variables/confgurations possible by adding unique configname to SAMBA_VOLUME_CONFIG_
  • take a look at https://wiki.samba.org/index.php/Configure_Samba_to_Work_Better_with_Mac_OS_X⁠ -> EXPLANATION OF VOLUME PARAMETERS
  • seperate multiple lines using ; which will be automatically translated to \n
  • if your path variable ends with %U e.g. path = /shares/homes/%U; multi user mode gets activated and each user gets their own subdirectory for their own share. (great for timemachine - every user get's his own personal share)
  • for timemachine only add fruit:time machine = yes and all other needed settings are automatically added
    • you can also use fruit:time machine max size = 500G; to limit max size of time machine volume

• WSDD2_DISABLE

  • optional
  • default not set - set to any value to disable wsdd2 Service

• WSDD2_PARAMETERS

  • optional specify parameters for wsdd2
  • default not set - wsdd2 starts without any parameters
  • e.g. -l

⁠Volumes

• your shares

  • by default I recommend mounting all shares beneath /shares and configure them using the path property

• /external/avahi

  • mount your avahi service folder e.g. /etc/avahi/services/ to this spot
  • the container now maintains the service file samba.service for you - it will be overwritten!
  • when mounted, the internal avahi daemon will be disabled

⁠Some helpful indepth informations about TimeMachine and Avahi / Zeroconf

⁠General Infos

• Samba

  • https://github.com/willtho89/docker-samba-timemachine/⁠
  • https://github.com/sp00ls/SambaConfigs⁠ very interessting multi user timemachine setup
  • https://wiki.samba.org/index.php/Configure_Samba_to_Work_Better_with_Mac_OS_X⁠
  • https://serverfault.com/questions/1010822/samba4-issues-with-time-machine-cannot-create-new-backup-on-samba-share⁠

• Avahi

  • https://openwrt.org/docs/guide-user/services/nas/samba_configuration#zeroconf_advertising⁠
  • http://samba.sourceforge.net/wiki/index.php/Bonjour_record_adisk_adVF_values⁠
  • https://linux.die.net/man/5/avahi.service⁠

You can't proxy the zeroconf inside the container to the outside, since this would need routing and forwarding to your internal docker0 interface from outside. So you need to use the network=host mode to enable zeroconf from within the container

You can just expose the needed Port 548 to the docker hosts port and install avahi. After that just add a new service which fits to your config.

⁠Windows 10 Network Discovery

For the Windows 10 Network Discovery the hostname of the container is used. If you use network_mode: host then it's the docker-host hostname.

If you use any other network_mode and want to avoid the autogenerated cryptic hostname of the container, you can specify a explicit hostname using: hostname: my-samba-containers-hostname

• WSD
  • https://devanswers.co/discover-ubuntu-machines-samba-shares-windows-10-network/⁠
  • https://github.com/Netgear/wsdd2⁠

Note: This wsdd2 service seems to need CAP_NET_ADMIN as a capability. (more info: https://github.com/ServerContainers/samba/issues/50⁠)

    cap_add:
      - CAP_NET_ADMIN