Skip to content

Commit e683691

Browse files
committed
Make security design documentation clearer
1 parent e454cf8 commit e683691

File tree

1 file changed

+22
-17
lines changed

1 file changed

+22
-17
lines changed

samba-timemachine/README.md

+22-17
Original file line numberDiff line numberDiff line change
@@ -30,27 +30,25 @@ To enable discovery copy the [service file](timemachine.service) to `/etc/avahi/
3030

3131
# Settings
3232

33-
| Variable | Function | Default. |
34-
|-------------|:------------------------------------:|------------:|
35-
| `USER` | Time Machine Username | `timemachine` |
36-
| `PASS` | Time Machine Password | `password` |
37-
| `PUID` | Unix User ID for Time Machine user | `999` |
38-
| `PGID` | Unix Group ID fror Time Machine user | `999` |
39-
| `LOG_LEVEL` | SAMBA logging level | `999` |
40-
| `QUOTA` | Time Machine Quota in MB | `512000` |
33+
| Variable | Function | Default. |
34+
|-------------|:-----------------------------------:|--------------:|
35+
| `USER` | Time Machine Username | `timemachine` |
36+
| `PASS` | Time Machine Password | `password` |
37+
| `PUID` | Unix User ID for Time Machine user | `999` |
38+
| `PGID` | Unix Group ID for Time Machine user | `999` |
39+
| `LOG_LEVEL` | SAMBA logging level | `2` |
40+
| `QUOTA` | Time Machine Quota in MB | `512000` |
4141

4242
# Security
4343

44-
The security design is basic, I assume that timemachine backups are encrypted from the source macOS device.
45-
The container creates a user timemachine on startup, with by default a password of `password`
44+
The security design is simple and assumes that timemachine backups are encrypted from the source macOS device.
4645

47-
A custom password can be passed to the container with the environment variable `PASS`.
46+
The default configuration of the container creates a unix user called `timemachine` with uid and gid 999, and
47+
a matching SAMBA user called `timemachine` with a password of `password`.
4848

49-
# Storage
49+
A custom username can be passed to the container with the environment variable `USER`.
5050

51-
I have had some performance problems using ZFS as a backing store for the container in Catalina.
52-
I'm not sure if this because of the slow SMR drive I was using or by ZFS's copy on write design interacting badly with APFS.
53-
I have changed the backend storage that I use to ext4 which has been working well.
51+
A custom password can be passed to the container with the environment variable `PASS`.
5452

5553
# Quotas
5654

@@ -78,9 +76,16 @@ The container can be started with SAMBA debugging flags for example: `--debuglev
7876
There is a utility function in the run script that will print out macOS timemachine logs and then follow them to use it call:
7977
`./run timemachineLogs`
8078

81-
# Versions
79+
# Storage notes
80+
81+
Generally speaking timemachine backups are heavy metadata workloads.
82+
I have had some performance problems using ZFS as a backing store for the container in Catalina.
83+
I'm not sure if this because of the slow SMR drive I was using or by ZFS's copy on write design interacting badly with APFS.
84+
I have changed the backend storage that I use to ext4 which has been working well.
85+
86+
# Software Versions
8287

83-
* [Debian Bookworm Slim](https://hub.docker.com/_/debian?tab=tags&page=1&name=bookworm-slim)
88+
* [Debian Bookworm](https://hub.docker.com/_/debian?tab=tags&page=1&name=bookworm-slim)
8489
* [SAMBA](https://packages.debian.org/bookworm/samba) [4.16.4](https://www.samba.org/samba/history/samba-4.16.4.html)
8590

8691
# Areas for improvement

0 commit comments

Comments
 (0)